查看维度列表

接口描述

本接口用于获取指定条件下的维度列表信息。通过传递相应的查询参数，类目、责任人及自定义关键词等条件，检索出符合需求的维度实体详情。

接口URL

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

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。

请求参数

参数	类型	是否必选	描述
categoryId	String	否	维度类目ID
owners	Array[String]	否	负责人用户ID
keyword	String	否	根据关键字搜索dimName、dimDisplayName
statusFilters	List	否	维度状态，根据维度的状态进行查询。维度状态枚举值如下：UNPUBLISHED：未发布PUBLISHED：已发布SAVED_NOT_PUBLISHED：已保存未发布OFFLINE：已下线PENDING_PUBLISH：发布中PENDING_OFFLINE：下线中PENDING_DELETE：待删除
datasetName	String	否	数据集的名称
pager	Object	否	分页器详情请见：子表 1

子表 1： pager

参数	类型	是否必选	描述
pageNumber	Intger	是	页码
pageSize	Intger	是	当前页面展示的条数

响应参数

响应参数说明

参数	类型	是否必选	描述
code	String	是	接口响应码
success	boolean	是	是否请求成功
errorMsg	String	是	报错信息
detailErrorMsg	String	是	报错详情
traceId	String	是	跟踪ID，用于问题排查
data	Array[Object]	是	维度实体数据，具体参数详情参见：4.2data 参数说明

data 参数说明

参数	类型	是否必选	描述
dimName	String	是	维度名称 - 租户下唯一，且不可修改 - 仅支持字母、数字、下划线（不支持连续两个下划线）
dimCode	String	是	维度编码
datasetName	String	否	数据集名称
dimDisplayName	String	是	维度中文名，支持任意字符，长度 150字符以内
dimCategoryId	String	否	维度类目id，如果是未分类，为固定值"-1"，如果不传默认是未分类
dimDescription	String	否	维度描述，支持任意字符，长度 300字符以内
displayStatus	String	否	维度状态，返回维度的所属状态，状态枚举值如下：UNPUBLISHED：未发布PUBLISHED：已发布SAVED_NOT_PUBLISHED：已保存未发布OFFLINE：已下线PENDING_PUBLISH：发布中PENDING_OFFLINE：下线中PENDING_DELETE：待删除
config		是	维度来源，字段或者表达式。具体参数说明参见 4.3config 参数说明

config 参数说明

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

请求示例

{
  "owners":[],
  "categoryId": "-1",
  "keyword": "订单",
  "datasetName": "region",
  "pager": {
    "pageNumber": 1,
    "pageSize": 50
  }
}

响应示例

{
    "data": {
        "total": 1,
        "pageNumber": 1,
        "pageSize": 50,
        "hasNext": false,
        "data": [
            {
                "basicAttributes": null,
                "businessAttributes": null,
                "technicalAttributes": null,
                "managementAttributes": null,
                "name": "76cb38381976489f9e88248924c69b54",
                "dimName": "column_0",
                "dimDisplayName": "订单ID",
                "dimCategoryId": "-1",
                "dimDescription": null,
                "datasetName": "region",
                "originDataType": "VARCHAR",
                "config": {
                    "type": "COLUMN_BIND",
                    "value": "column_0"
                }
            }
        ]
    },
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "202baf375f5d4791a9f9555ba33afe43.143.17193060863270127"
}