跳转至

删除指标

接口说明

本接口用于删除指标。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/metrics/delete

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户ID,用于指标查询内容所在的租户
auth-type String 认证方式。支持 UIDTOKENACCOUNTAPIKEY
auth-value String auth-type 对应的认证值
queryBy String 指定查询时使用的标识方式。传 UUID 时使用指标 code 删除;不传时默认按接口配置识别指标英文名或编码

公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成,在 API 集成界面获取;auth-value 请按 auth-type 填写对应认证值。

Query/Form 请求参数

参数 类型 是否必选 最大长度 描述
metricName String 128 待删除的指标名称或指标 code,具体含义由 queryBy 决定

注意:metricName 是 request parameter,请放在 URL query 参数或 application/x-www-form-urlencoded 表单中

响应参数

参数 类型 是否必选 最大长度 描述
code String 32 接口响应码
success Boolean - 请求是否成功
errorMsg String 512 报错信息
detailErrorMsg String - 报错详情
traceId String 128 跟踪 ID,用于问题排查
data Boolean - 是否删除成功

请求示例

Query 参数方式:

curl -X POST 'http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/metrics/delete?metricName=OrderCount' \
  -H 'tenant-id: <tenant-id>' \
  -H 'auth-type: APIKEY' \
  -H 'auth-value: <auth-value>'

响应示例

{
  "data": true,
  "success": true,
  "code": "200",
  "errorMsg": null,
  "detailErrorMsg": null,
  "traceId": "fdde6861bd554805998343f9ff2dcd70.292.16857691758642861"
}