单个指标详情查询

接口描述

本接口适用于查询指标的详情。

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/metrics/detail

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	指标名称

响应参数

相应参数说明


参数	类型	是否必选	最大长度	描述
code	String	是	64	接口响应码
message	String	是	512	消息体
traceId	String	是	128	traceId
data	Array[Object]	是		响应结果。具体参数说明参见：4.2data 参数说明

data 参数说明


参数	类型	是否必选	最大长度	描述
code	String	否		`指标编码`指标唯一标识，系统内部生成
metricName	String	是	128	`指标名称`
version	Int	否		`指标版本`
metricCode	String	否		`指标编码`
type	String	是		`指标类型`
metricDisplayName	String	是		`指标中文名`
businessCaliber	String	否		`指标业务口径`
caliber	Array	是		`指标计算口径`
owner	String	否		`指标负责人名称`
businessOwner	String	否		`指标业务负责人名称`
unit	String	否		`指标单位`更多详情请参见 4.3 指标单位说明
cnUnit	String	否		`中文指标单位`更多详情请参见 4.3 指标单位说明
metricCategoryId	String	否		`指标类目 ID`
basicAttributes	Map	否		`基础属性`
businessAttributes	Map	否		`业务属性`
technicalAttributes	Map	否		`技术属性`
managementAttributes	Map	否		`管理属性`
metricViewCount	Integer	是		`指标查询次数`
viewDetailCount	Integer	是		`指标浏览量`
status	String	是		`指标终态`：枚举值如下：ONLINE：线上OOFLINE：线下
publishStatus	String	是		`发布状态`：枚举值如下：DRAFT：草稿PUBLISHED：已发布
displayStatus	String	否		`指标状态`指标当前所属状态，状态枚举值如下：UNPUBLISHED：未发布PUBLISHED：已发布SAVED_NOT_PUBLISHED：已保存未发布OFFLINE：已下线PENDING_PUBLISH：发布中PENDING_OFFLINE：下线中PENDING_DELETE：待删除
gmtCreate	String	否		`创建时间`：指标创建的时间
gmtUpdate	String	否		`修改时间`：指标修改的时间

指标单位说明


类别	枚举值	中文
货币单位	CNY_FEN	分（人民币）
CNY_YUAN	元（人民币）
CNY_WAN	万元（人民币）
CNY_BAI_WAN	百万元（人民币）
CNY_YI_YUAN	亿元（人民币）
USD_CENT	分（美元）
USD_DOLLAR	元（美元）
EUR_EURO	元（欧元）
HKD_DOLLAR	元（港币）
NEW_TAIWAN_DOLLAR	元（新台币）
时间单位	DAY	天
MONTH	月
WEEK	周
YEAR	年
HOUR	时
MINUTE	分
SECOND	秒
QUARTER	季度
MILLISECOND	毫秒
比例单位	DECIMAL	小数
PERCENTAGE	百分位数
PERMILLE	千分位数
名词	RANK	排名
对象量次	HOUSEHOLD	户
TRANSACTION	笔
ITEM	件
INDIVIDUAL	个
OCCURRENCE	次
PERSON_DAY	人日
FAMILY	家
HAND	手
SHEET	张
PACKAGE	包
重量单位	TON	吨
KILOGRAM	公斤
其他	OTHER	其他

请求示例

http://127.0.0.1/anymetrics/api/v1/metrics/detail?metricName=orderCount

响应示例

{
    "data": {
        "basicAttributes": {},
        "businessAttributes": {},
        "technicalAttributes": {},
        "managementAttributes": {},
        "code": "1d45e0191f9348dd9a242fa0839d13a9",
        "metricName": "ordercount_12",
        "metricDisplayName": "订单量_自定义聚合函数4",
        "businessCaliber": "这是openAPI创建的指标1",
        "owner": "correctness_test_qq",
        "businessOwner": "correctness_test_qq",
        "type": "ATOMIC",
        "caliber": {
            "datasetName": "can_order",
            "expr": "count(['can_order'/'order_id'])",
            "formula": null,
            "filters": [
                {
                    "type": "EXPR",
                    "expr": "IN(['can_product'/'brand_name'],\"华为\")"
                }
            ],
            "metricTime": "order_date",
            "enableNonAdditiveDimensions": null,
            "nonAdditiveDimensions": null,
            "fingerPrint": null
        },
        "unit": "OTHER",
        "metricCategoryId": "-1",
        "metricViewCount": 0,
        "publishStatus": "PUBLISHED",
        "status": "ONLINE"
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "f6e656798ed241c789f7132823c46c6b.145.17194017310870337"
}