跳转至

修改维度

接口描述

本接口旨在实现对指定维度元数据的更新操作,通过指定dimNametenantId作为关键定位标识,系统支持对除维度名称外的多属性进行调整。

接口URL

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

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,其他属性都允许用户修改

请求参数说明

参数 类型 是否必选 描述
dimName String 维度名称

- 租户下唯一,且不可修改

- 仅支持字母、数字、下划线(不支持连续两个下划线)
datasetName String 数据集名称
dimDisplayName String 维度中文名,支持任意字符,长度150字符以内
dimCategoryId String 维度类目ID,如果是未分类,为固定值"-1",如果不传默认是未分类
dimDescription String 维度描述,支持任意字符,长度300字符以内
config object 维度来源,具体参数说明请参见 3.2.2 config 参数说明
valueList object
basicAttributes Map 基础属性
businessAttributes Map 业务属性
technicalAttributes Map 技术属性
managementAttributes Map 管理属性

config 参数说明

参数 类型 是否必选 描述
type String 维度类型,说明维度的来源方式,枚举值:

- COLUMN_BIND:字段绑定

- CUSTOM:自定义类型
value String - 如果是字段绑定类型的维度,value为字段名称

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

valuesList 参数说明

参数 类型 是否必选 描述
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": "tb_click_1维度修改",
    "datasetName": "tb_click",
    "config": {
        "type": "COLUMN_BIND",
        "value": "user_id"
    },
    "valueList": [
    {
      "value": "维值03",
      "name": "维值03",
      "description": "维值03"
    },
    {
      "value": "维值04",
      "name": "维值04",
      "description": "维值04"
    }
  ]
}

响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "ad3cd6c9fd5849b6a271f02f89edc93e.149.17193918167290023"
}