API 获取维度值

接口描述

本接口用于预览指定维度的取值情况，支持基于关键词的模糊匹配以及分页查询功能。它适用于租户环境下的指标数据查询，通过精确或模糊匹配维度值。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/dimension/values

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

请求参数

公共请求参数(HEADERS)


参数	类型	是否必选	最大长度	描述
tenant-id	String	是	32	`租户ID`，用于指标查询内容所在的租户
auth-type	String	是	32	认证方式支持：`UID`（基于用户ID认证）`TOKEN`（基于令牌认证）。
auth-value	String	是	32	与选定的`auth-type`相对应的认证值。

公共参数获取方式

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

请求参数

请求参数说明


参数	类型	是否必选	描述
dimName	String	是	`维度名称`
dimValueKeyword	String	否	维度值的关键词。如果指定，可以按照这个关键词进行模糊匹配。匹配模式是like '%keyword%'，该选项只对字符串类型的维度有效，其他类型的维度会自动忽略该属性
pageNumber	Integer	否	页码，从1开始，如果不填，则默认为1
pageSize	Integer	否	每页数据记录条数，如果不填默认为200

响应参数

响应参数说明


参数	类型	是否必选	描述
code	String	是	接口响应码
success	boolean	是	是否请求成功
errorMsg	String	是	报错信息
detailErrorMsg	String	是	报错详情
traceId	String	是	跟踪ID，用于问题排查
data	object	是	结果数据，具体参数详情见 4.2metas 参数说明和 4.2tables 参数说明

metas 参数说明


参数	类型	是否必选	最大长度	描述
name	String	是	32	字段名称
dataTypeName	String	是	32	字段类型名称
schemaName	String	是	128	schema名称
tableName	String	是	128	table名称

tables 参数说明


参数	类型	是否必选	最大长度	描述
values	String	是		查询的数据本身
order_date	String	是		这个值的标记
count	String	是		这个值有多少个，目前都是1

示例

{
    "dimName":"shop_id"
}

响应示例

{
    "data": {
        "queryId": "4e06378a84af4f0f98333ff31ed6ad1c",
        "warning": null,
        "sql": "SELECT `tn_597771_correctness_test_qq_datasource__default__can_shop`.`shop_id`\nFROM `default_catalog`.`aloudatacan`.`tn_597771_correctness_test_qq_datasource__default__can_shop` AS `tn_597771_correctness_test_qq_datasource__default__can_shop`\nGROUP BY `tn_597771_correctness_test_qq_datasource__default__can_shop`.`shop_id`\nORDER BY (`tn_597771_correctness_test_qq_datasource__default__can_shop`.`shop_id`) IS NULL, `tn_597771_correctness_test_qq_datasource__default__can_shop`.`shop_id`\nLIMIT 200",
        "metas": [
            {
                "id": null,
                "name": "shop_id",
                "type": "INT",
                "displayName": null,
                "format": null,
                "description": null,
                "sourceType": null,
                "dataType": null,
                "columnFormat": null
            }
        ],
        "table": {
            "shop_id": [
                [
                    1,
                    1,
                    null
                ],
                [
                    2,
                    1,
                    null
                ],
                [
                    3,
                    1,
                    null
                ],
                [
                    4,
                    1,
                    null
                ],
                [
                    5,
                    1,
                    null
                ],
                [
                    6,
                    1,
                    null
                ],
                [
                    7,
                    1,
                    null
                ],
                [
                    8,
                    1,
                    null
                ]
            ]
        }
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "ad3cd6c9fd5849b6a271f02f89edc93e.145.17193921246800027"
}