跳转至

指标可用维度查询

接口描述

本接口用于查询某个指标可用的维度

接口URL

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

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为列名

- 如果是自定义类型的维度,需要指定一个表达式,这个表达式相当于在该数据集上添加的一个计算列

请求示例

http://127.0.0.1/anymetrics/api/v1/metrics/dimension?metricNames=code1&metricNames=code2

响应示例

{
    "data": [
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "96bb0438244f49c988bc2a453fd1a457",
            "dimName": "Customers_Address",
            "dimCode": null,
            "dimDisplayName": "Address",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "Customers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "Address"
            },
            "displayStatus": null
        },
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "bb9e257f3ba84893a7c05ea40172ce79",
            "dimName": "Units_1",
            "dimCode": "",
            "dimDisplayName": "Units",
            "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": "046818b86a6946798787d6511f47b9f9",
            "dimName": "CustomerManagers_AllocationDate",
            "dimCode": null,
            "dimDisplayName": "AllocationDate",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "CustomerManagers",
            "originDataType": "DATE",
            "config": {
                "type": "COLUMN_BIND",
                "value": "AllocationDate"
            },
            "displayStatus": null
        },
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "47331a313f404dcba3b0f45897099599",
            "dimName": "CustomerManagers_CustomerID",
            "dimCode": null,
            "dimDisplayName": "CustomerID",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "CustomerManagers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "CustomerID"
            },
            "displayStatus": null
        }
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "aa7b50fa04824d36ae6142c14a1fa589",
            "dimName": "FundManagers_ManagerName",
            "dimCode": null,
            "dimDisplayName": "ManagerName",
            "dimCategoryId": "-1",
            "dimDescription": null,
            "datasetName": "FundManagers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "ManagerName"
            },
            "displayStatus": null
        },
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "5035867a5a67416fbacca095c65136ec",
            "dimName": "CustomerManagers_ManagerName",
            "dimCode": null,
            "dimDisplayName": "ManagerName",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "CustomerManagers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "ManagerName"
            },
            "displayStatus": null
        },
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "c930e00b37714c6f878ab62af2bb96bb",
            "dimName": "CustomerManagers_ContactEmail",
            "dimCode": null,
            "dimDisplayName": "ContactEmail",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "CustomerManagers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "ContactEmail"
            },
            "displayStatus": null
        },
        {
            "basicAttributes": null,
            "businessAttributes": null,
            "technicalAttributes": null,
            "managementAttributes": null,
            "name": "485297647d044dc8b2ca26ec5a24e621",
            "dimName": "Customers_CustomerName",
            "dimCode": null,
            "dimDisplayName": "CustomerName",
            "dimCategoryId": "8a2977b7-4998-4bb1-aeee-a20e6f73f8d0",
            "dimDescription": null,
            "datasetName": "Customers",
            "originDataType": "VARCHAR",
            "config": {
                "type": "COLUMN_BIND",
                "value": "CustomerName"
            },
            "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": "4e9d90ec920d413fb58b9c744dcdbb1f.149.17267154343391151"
}