创建维度
接口说明
本接口用于在 Aloudata CAN 平台上创建新的维度信息。
接口URL
POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/dimension/create
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 | 是 | 维度名称- 租户下唯一，且不可修改 - 仅支持字母、数字、下划线（不支持连续两个下划线） |
| datasetName | String | 否 | 数据集名称 |
| dimDisplayName | String | 是 | 维度中文名，支持任意字符，长度150字符以内 |
| dimCategoryId | String | 否 | 维度类目ID，如果是未分类，为固定值"-1"，如果不传默认是未分类 |
| dimDescription | String | 否 | 维度描述，支持任意字符，长度300字符以内 |
| config | array | 是 | 维度来源，字段或者表达式，具体参数说明请参见：config 参数说明 |
| valueList | array | 是 | 维值列表，具体参数说明请参见 valueslist 参数说明 |
| basicAttributes | Map |
否 | 基础属性 |
| businessAttributes | Map |
否 | 业务属性 |
| technicalAttributes | Map |
否 | 技术属性 |
| managementAttributes | Map |
否 | 管理属性 |
config 参数说明
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| type | String | 是 | 维度类型，说明维度的来源方式，枚举值：- COLUMN_BIND：字段绑定 - CUSTOM：自定义类型 |
| value | String | - 如果是字段绑定类型的维度，value为列名 - 如果是自定义类型的维度，需要指定一个表达式，这个表达式相当于在该数据集上添加的一个计算列 |
valuelist 参数说明
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| value | String | 否 | 原始维值，不能为空字符串或null |
| name | String | 映射的名，不能是空字符串或null |
|
| description | String | 描述维值描述信息 |
响应参数
| 参数 | 类型 | 是否必选 | 描述 | |
|---|---|---|---|---|
| code | String | 是 | 接口响应码 | |
| success | boolean | 是 | 是否请求成功 | |
| errorMsg | String | 是 | 报错信息 | |
| detailErrorMsg | String | 是 | 报错详情 | |
| traceId | String | 是 | 跟踪ID，用于问题排查 | |
| data | Boolean | 是 | 是否创建成功 |
请求示例
{
"dimName": "tb_click_1",
"dimDisplayName": "tb_click_1",
"dimCategoryId": "-1",
"dimDescription": "weidu",
"datasetName": "tb_click",
"config": {
"type": "COLUMN_BIND",
"value": "user_id"
},
"valueList": [
{
"value": "维值01",
"name": "维值01",
"description": "维值01"
},
{
"value": "维值02",
"name": "维值02",
"description": "维值02"
}
]
}