更新时间:2026-09-24 GMT+08:00
分享

删除数据类 - DeleteDataClass

功能介绍

删除自定义数据类

调用方法

请参见如何调用API。

授权信息

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

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间ID,用于指定操作的工作空间范围。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

获取方式:

可通过调用查询数据类列表接口获取,也可从控制台获取。

dataclass_id

是

String

参数解释:

数据类的唯一ID,用于指定操作的数据类。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

获取方式:

可通过调用查询数据类列表接口获取,也可从控制台获取。

表2 Query参数

参数

是否必选

参数类型

描述

is_delete

是

Boolean

参数解释:

是否删除数据类

约束限制:

不涉及

取值范围:

  • true:删除数据类

  • false:不删除数据类

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

是

String

参数解释:

请求体的内容类型,用于指定请求体的媒体类型

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of DeleteDataClassResponseBody objects

参数解释:

删除数据类返回对象列表,元素类型为DeleteDataClassResponseBody对象

表5 DeleteDataClassResponseBody

参数

参数类型

描述

type

String

参数解释:

被引用对象的类型

取值范围:

  • LAYOUT:布局

  • AOPWORKFLOW:工作流

  • PLAYBOOK:剧本

  • DATACLASS_TYPE:数据类类型

count

Integer

参数解释:

被引用数量

取值范围:

不涉及

detail_url

String

参数解释:

被引用console跳转地址

取值范围:

不涉及

data

Array of data objects

参数解释:

被引用对象列表,元素为data对象,包含被引用对象的id和名称信息

表6 data

参数

参数类型

描述

id

String

参数解释:

被引用对象id

取值范围:

不涉及

name

String

参数解释:

被引用对象名称

取值范围:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述

取值范围:

不涉及

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

删除自定义数据类

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

{
  "is_delete" : true
}

响应示例

状态码:200

{
  "type" : "DATACLASS",
  "count" : 4,
  "detail_url" : "www.xyz.com",
  "data" : [ {
    "id" : "3e94505d-478f-4619-bef9-2c60a9fe3401",
    "name" : "name"
  } ]
}

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码。

相关文档