跳转至

修改指标

接口描述

本接口是用于在指标平台中创建一个指标。

接口URL

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

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

请求参数

公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 租户ID,用于指标查询内容所在的租户
auth-type String 32 认证方式,用于设置身份认证方式 UID:使用 UID 进行身份认证TOKEN:使用 TOKEN 进行身份认证
auth-value String 32 UID或者TOKEN值,与auth-type 类型选择一致

公共参数获取方式

tenant-id 与 auth-value:在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成。在 API 集成界面获取取到tenant-id 与auth-value。

请求参数

参数 类型 最大长度 是否必选 描述
metricName String 128 指标名称指标唯一标识,不可修改,仅支持英文、下划线、数字和空格
metricDisplayName String 128 指标中文名,支持任意字符
businessCaliber String 300 业务口径
type String 指标类型,是一个枚举类型ATOMIC:原子指标DERIVED:派生指标COMPOSITE:复合指标
owner String 负责人的用户id
businessOwner String 业务负责人的用户id
caliber String 指标计算口径,每种指标的计算口径见下面的表格
unit String 指标单位
metricCategoryId String 类目 ID。“未分类”类目为系统内置的,categoryId为"-1"。如果不传,默认是“未分类”。
basicAttributes Map 基础属性
businessAttributes Map 业务属性
technicalAttributes Map 技术属性
managementAttributes Map 管理属性

响应参数

响应参数说明

参数 类型 是否必选 最大长度 描述
code String 32 接口响应码
message String 512 消息体
traceId String 128 traceId
data array 影响结果。具体参数说明参见:4.2data 参数说明

data 参数说明

参数 类型 是否必选 最大长度 描述
result Boolean 新建是否成功

请求示例

{
    "type": "ATOMIC",
    "metricDisplayName": "订单量_自定义聚合函数5",
    "metricName": "ordercount_3",
    "owner": "correctness_test_qq",
    "businessOwner": "correctness_test_qq",
    "businessCaliber": "这是修改后的",
    "metricCategoryId": "-1",
    "unit": "OTHER",
    "caliber": {
        "datasetName": "can_order",
        "expr": "count(['can_order'/'order_id'])",
        "metricTime": "order_date",
        "filters": [
            {
                "type": "EXPR",
                "expr": "IN(['can_product'/'brand_name'],\"华为\")"
            }
        ]
    },
    "basicAttributes": {
        "a": "1"
    },
    "businessAttributes": {
        "b": "2"
    },
    "technicalAttributes": {
        "c": "3"
    },
    "managementAttributes": {
        "d": "4"
    }
}

响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "f6e656798ed241c789f7132823c46c6b.141.17194028392300357"
}