获取指标列表

接口描述

本接口用于获取某个租户下所有的指标列表。

接口URL

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

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。

请求参数


参数	类型	是否必选	描述
keyword	String	否	搜索关键词
metricCategoryId	String	否	指标所属类目，如果不传，默认查询所有类目下的指标，如果查询未分类下的指标，则传入"-1"
statusFilters	List	否	指标所属状态，如果不传，默认查询所有状态下的指标。枚举值如下：UNPUBLISHED：未发布PUBLISHED：已发布SAVED_NOT_PUBLISHED：已保存未发布OFFLINE：已下线PENDING_PUBLISH：发布中PENDING_OFFLINE：下线中PENDING_DELETE：待删除
pageNumber	int	否	当前页
pageSize	int	否	页大小

响应参数

响应参数说明


参数	类型	是否必选	最大长度	描述
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	是		`指标编码`平台开启指标编码后，手动指定
metricDisplayName	String	是	128	`指标展示名`
businessCaliber	String	否	300	`指标描述信息`
owner	String	是		`指标负责人`
businessOwner	String	是		`业务负责人`
metricCategoryId	String	是		`指标类目 ID`
type	String	是		`指标类型`(ATOMIC/derived/composite)
status	String	是		`指标终态`：枚举值如下：ONLINE：线上OOFLINE：线下
publishStatus	String	是		`发布状态`：枚举值如下：DRAFT：草稿PUBLISHED：已发布
displayStatus	String	否		`指标状态`指标当前所属状态，状态枚举值如下：UNPUBLISHED：未发布PUBLISHED：已发布SAVED_NOT_PUBLISHED：已保存未发布OFFLINE：已下线PENDING_PUBLISH：发布中PENDING_OFFLINE：下线中PENDING_DELETE：待删除
unit	String	否		`指标单位`，更多详情请参见：4.4 指标单位说明
cnUnit	String	否		`中文指标单位`，更多详情请参见：4.4 指标单位说明
metricViewCount	Integer	是		`指标查询次数`
properties	Array	否		`指标属性`。具体参数说明参见 4.3properties 参数说明
gmtCreate	String	否		`创建时间`：指标创建的时间
gmtUpdate	String	否		`修改时间`：指标修改的时间
timeGranularity	String	是		时间粒度（数据统计的时间单位，当前未设置，值为 null）
hasDateLimit	Boolean	是		是否有日期限制（false 表示无限制）
hasDerivationMethod	Boolean	是		是否有衍生方法（false 表示非衍生指标，无衍生逻辑）
metricTimeDataType	Boolean	是		指标时间数据类型（DATE_TIME 表示包含具体时间）
canEdit	String	是		是否允许编辑该指标（true 表示有权限）
canDelete	Boolean	是		是否允许删除该指标（true 表示有权限）
canUsage	Boolean	是		是否允许使用该指标（true 表示有权限）
canAuth	Boolean	是		是否允许授权该指标给他人（true 表示有权限）
canTransfer	Boolean	是		是否允许转移该指标的所有权（true 表示有权限）

properties


参数	类型	是否必选	最大长度	描述
MANAGE	String	否	128	`管理属性`
BUSINESS	String	否		`业务属性`
TECHNOLOGY	String	否	128	`技术属性`
BASE	String	否	300	`基础属性`

指标单位说明


类别	枚举值	中文
货币单位	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/list?keyword=Test&pageNumber=1&pageSize=1&metricCategoryId=-1

响应示例

{
    "data": {
        "total": 67,
        "pageNumber": 1,
        "pageSize": 20,
        "hasNext": true,
        "data": [
            {
                "code": "1a1234b829db4b3eb97af9fd1d9a0c67",
                "metricName": "count_CustomerNamess",
                "version": 2,
                "metricCode": null,
                "metricDisplayName": "客户数量",
                "businessCaliber": "对Customers的CustomerName进行计数",
                "owner": null,
                "businessOwner": "jingming",
                "type": "ATOMIC",
                "unit": "OTHER",
                "cnUnit": "其他",
                "metricCategoryId": "8e57c5b8-dca7-45ea-9ec5-35d17d6e67dd",
                "metricViewCount": 61,
                "status": "ONLINE",
                "publishStatus": "PUBLISHED",
                "properties": {
                    "MANAGE": {},
                    "BUSINESS": {
                        "businessOwner": "jingming"
                    },
                    "TECHNOLOGY": {},
                    "BASE": {
                        "metricLevel": "T4"
                    }
                },
                "displayStatus": "PUBLISHED",
                "gmtCreate": "2024-10-08 15:39:11",
                "gmtUpdate": "2024-10-08 15:40:12"
            }

        ]
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "2f609a60ed284e7384a6828b29fe25a0.152.17284434132120547"
}