文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V2/ 表管理/ 批量修改表元数据 - BatchModifyTableMetaData
更新时间:2026-09-30 GMT+08:00
分享

批量修改表元数据 - BatchModifyTableMetaData

功能介绍

批量修改指定表的元数据信息

调用方法

请参见如何调用API。

授权信息

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

URI

PUT /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/metadata/batch-modify

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间ID,用于标识安全云脑中的工作空间,确定操作所属的工作空间范围。可以通过调用API获取,也可以从控制台获取。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

table_id

是

String

参数解释:

表ID,用于标识安全云脑中的数据表。可以通过调用API获取,也可以从控制台获取。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

command

是

String

参数解释:

操作命令类型,用于指定对表元数据的操作方式。

约束限制:

不涉及

取值范围:

  • INSERT:写入,向表中插入新的元数据记录

  • DELETE:删除,从表中删除指定的元数据记录

  • UPDATE:更新,修改表中已有的元数据记录

  • TRUNCATE:清空,清除表中的所有元数据记录

默认取值:

不涉及

batch_no

否

String

参数解释:

批次编号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

records

否

Array of records objects

参数解释:

记录列表,用于指定需要修改的元数据键值对。每个元素为一个包含key(元数据键)和value(元数据值)的对象。

约束限制:

不涉及

表4 records

参数

是否必选

参数类型

描述

key

是

String

参数解释:

元数据键

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

value

是

String

参数解释:

元数据值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

result

Boolean

参数解释:

操作结果

取值范围:

  • true: 操作成功

  • false: 操作失败

table_id

String

参数解释:

表ID,可以为null

取值范围:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

{
  "command" : "INSERT",
  "batch_no" : "batch_001",
  "records" : [ {
    "key" : "字段名称",
    "value" : "字段值"
  }, {
    "key" : "字段类型",
    "value" : "string"
  } ]
}

响应示例

状态码:200

{
  "result" : true,
  "table_id" : "1axxxxx9z"
}

状态码

状态码

描述

200

请求成功

400

错误响应

错误码

请参见错误码。

相关文档