指标可用维度全量查询

接口描述

本接口用于查询某个或多个指标全量的可用维度。

接口URL

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

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。

请求参数

参数	类型	是否必选	最大长度	描述
metricNames	Array[String]	是		指标名称集合说明：当传入多个指标时，会分别获取指标的全部可用维度

响应参数

响应参数说明

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

data 参数说明

参数	类型	是否必选	最大长度	描述
basicAttributes	Map	否		基础属性
businessAttributes	Map	否		业务属性
technicalAttributes	Map	否		技术属性
managementAttributes	Map	否		管理属性
name	String	是		维度名称
dimName	String	是		维度英文名
dimCode	String	否		维度编码
dimDisplayName	String	是		维度展示名
dimCategoryId	String			维度所在类目 ID
dimDescription	String			维度描述
datasetName	String			维度绑定的数据集名称
originDataType	String			维度的类型
config	array			维度来源说明，具体参数详情参见：4.3config 参数说明

config 参数说明

参数	类型	是否必选	描述
type	String	是	维度类型，说明维度的来源方式，枚举值： - COLUMN_BIND：字段绑定 - CUSTOM：自定义类型
value	String	是	- 如果是字段绑定类型的维度，value为列名 - 如果是自定义类型的维度，需要指定一个表达式，这个表达式相当于在该数据集上添加的一个计算列

请求示例

curl --location --request GET 'https://127.0.0.1/anymetrics/api/v1/metrics/dimensionAll?metricNames=addtid,1c_RANK' \
--header 'auth-type: UID' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' 

响应示例

{
    "data": {
        "addtid": [
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "metric_time",
                "dimName": "metric_time",
                "dimCode": null,
                "dimDisplayName": "metric_time",
                "dimCategoryId": null,
                "dimDescription": "metric time",
                "datasetName": null,
                "originDataType": "DATE",
                "config": null,
                "displayStatus": null
            }
        ],
        "1c_RANK": [
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "dmd02724b1da08d1fb9007b16572563c",
                "dimName": "Unitss",
                "dimCode": "",
                "dimDisplayName": "Unitss",
                "dimCategoryId": "-1",
                "dimDescription": "Units",
                "datasetName": "TransactionDetails",
                "originDataType": "DECIMAL",
                "config": {
                    "type": "COLUMN_BIND",
                    "value": "Units"
                },
                "displayStatus": null
            },
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "dme36114b32b18abf2fbf2d63572b7ac",
                "dimName": "TransactionDates",
                "dimCode": "",
                "dimDisplayName": "TransactionDate",
                "dimCategoryId": "-1",
                "dimDescription": "TransactionDate",
                "datasetName": "TransactionDetails",
                "originDataType": "DATETIME",
                "config": {
                    "type": "COLUMN_BIND",
                    "value": "TransactionDate"
                },
                "displayStatus": null
            },
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "dmddd974b52803e7c3a89fe35f82effc",
                "dimName": "dtr1",
                "dimCode": null,
                "dimDisplayName": "分区日期",
                "dimCategoryId": "-1",
                "dimDescription": "这是一个分区维度",
                "datasetName": "TransactionDetails",
                "originDataType": "INT",
                "config": {
                    "type": "COLUMN_BIND",
                    "value": "dt"
                },
                "displayStatus": null
            },
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "dmeda0d4fc2ae54735319c0f7013d276",
                "dimName": "TransactionID1",
                "dimCode": "",
                "dimDisplayName": "TransactionID",
                "dimCategoryId": "-1",
                "dimDescription": "TransactionID",
                "datasetName": "TransactionDetails",
                "originDataType": "BIGINT",
                "config": {
                    "type": "CUSTOM",
                    "value": "if((DaysOfMonth(['TransactionDetails'/'TransactionDate'])) = (TotalDaysOfMonth(['TransactionDetails'/'TransactionDate'])), 1, 0)"
                },
                "displayStatus": null
            },
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "dm8e694432db67b6d8fc594c70b9fe2c",
                "dimName": "ten",
                "dimCode": "",
                "dimDisplayName": "times",
                "dimCategoryId": "-1",
                "dimDescription": "",
                "datasetName": "TransactionDetails",
                "originDataType": "DATETIME",
                "config": {
                    "type": "COLUMN_BIND",
                    "value": "ten"
                },
                "displayStatus": null
            },
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "metric_time",
                "dimName": "metric_time",
                "dimCode": null,
                "dimDisplayName": "metric_time",
                "dimCategoryId": null,
                "dimDescription": "metric time",
                "datasetName": null,
                "originDataType": "DATE",
                "config": null,
                "displayStatus": null
            }
        ]
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "4b5d80fad0fc44d0937253362b4e9da5.79456.17490900608203107"
}