更新时间:2026-06-26 GMT+08:00
分享

创建数据类 - CreateDataClass

功能介绍

创建自定义数据类

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

数据类名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

business_code

String

参数解释:

业务编码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

数据类描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

数据类ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

String

参数解释:

创建时间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

update_time

String

参数解释:

更新时间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

creator_id

String

参数解释:

创建者ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

creator_name

String

参数解释:

创建者名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

modifier_id

String

参数解释:

修改者ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

modifier_name

String

参数解释:

修改者名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cloud_pack_version

String

参数解释:

订阅包版本

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

is_built_in

Boolean

参数解释:

是否内置,true内置,false非内置

约束限制:

不涉及

取值范围:

  • true

  • false

默认取值:

不涉及

region_id

String

参数解释:

区域

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

String

参数解释:

项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

domain_id

String

参数解释:

账号ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

数据类名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

business_code

String

参数解释:

业务编码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

数据类描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

parent_id

String

参数解释:

父级ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

新建自定义数据类

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses

{
  "name" : "测试数据类",
  "business_code" : "TestClass",
  "description" : "测试数据类"
}

响应示例

状态码:200

请求成功

{
  "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "create_time" : "2021-01-30T23:00:00Z+0800",
  "update_time" : "2021-01-30T23:00:00Z+0800",
  "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "creator_name" : "zhangsan",
  "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "modifier_name" : "lisi",
  "cloud_pack_version" : "v1",
  "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "name" : "Evidence",
  "business_code" : "Evidence",
  "description" : "my description",
  "is_built_in" : false,
  "parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
}

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码

相关文档