跳转至

创建类目

接口描述

本接口用于在指标平台中新建指标类目或维度类目。

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/category/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。

请求参数

参数 类型 是否必选 最大长度 描述
name String 32 类目名称
categoryType String 32 类目类型
● 指标类目:CATEGORY_METRIC
● 维度类目:CATEGORY_DIMENSION
● 数据集类目:CATEGORY_DATASET
parentId String 64 父级类目ID,用于构建层级结构,可选。
frontId String 64 上级类目ID

响应参数

参数 类型 是否必选 最大长度 描述
code String 32 接口响应码
message String 512 消息体
traceId String 128 请求跟踪标识,有助于故障排查和日志关联。
errorMsg String 报错信息
detailErrorMsg String 报错详情
data String 64 新创建分类的唯一标识符(ID),用于后续操作引用。

请求示例

{
    "name":"api创建的类目01",
    "categoryType":"CATEGORY_METRIC",
    "parentId":null,
    "frontId":null
}

响应示例

{
  "data":"f88e7b90-bcff-4d48-85be-967ab77a2ed5",
  "success":true,
  "code":200,
  "errorMsg":null,
  "traceId":"b6bbdc8f33f642de9a250e690238bdff.254.17067705870260001"
}