文档首页/ 数据安全中心 DSC/ API参考/ API/ 资产透视/ 批量更新元数据字段信息 - UpdateFieldTags
更新时间:2026-11-13 GMT+08:00
分享

批量更新元数据字段信息 - UpdateFieldTags

功能介绍

功能介绍:批量更新元数据字段信息

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

PUT /v1/{project_id}/metadata/field-tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

patches

是

Array of patches objects

参数解释:

补丁列表,数组元素为 JSON Patch 对象,每个元素描述一个字段的修改操作

约束限制:

元素必须包含 op、path、value;description 字段值长度不超过255

取值范围:

不涉及

默认取值:

不涉及

ids

是

Array of strings

参数解释:

ID列表,每个元素为一条资源的合法 UUID

约束限制:

最多500个,每个元素必须为合法 UUID

取值范围:

不涉及

默认取值:

不涉及

columns

否

Array of integers

参数解释:

列列表,数组元素为Integer类型,每个元素表示一张表中列的顺序号

约束限制:

最多500个,元素必须大于等于0

取值范围:

不涉及

默认取值:

不涉及

category

是

String

参数解释:

元数据类别,用于标识待更新的元数据所归属的类别

约束限制:

不涉及

取值范围:

  • database-数据库

  • schema-数据模式

  • table-表

  • column-列

  • view-视图

  • all-全部

默认取值:

不涉及

表4 patches

参数

是否必选

参数类型

描述

op

是

String

参数解释:

操作类型,如 add、replace、remove

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

path

是

String

参数解释:

待更新字段路径,如 /description、/tags

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

value

是

AnyType

参数解释:

字段的新值,可为字符串、数字或对象(tags 场景为对象)

约束限制:

path 以 /tags 结尾时,value 需包含 labelType=MANUAL 和合法 tagCategory

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

status

String

参数解释:

操作结果状态,标识操作的处理结果,如成功、失败等

取值范围:

不涉及

msg

String

参数解释:

操作结果描述信息

取值范围:

不涉及

id

String

参数解释:

资源唯一标识ID,唯一标识一条资源记录,可通过查询资源列表接口获取

取值范围:

0到1024个字符,只能由英文字母、数字组成

请求示例

批量更新元数据字段信息

{
  "patches" : [ {
    "op" : "replace",
    "path" : "/description",
    "value" : "资产中心数据资源描述"
  } ],
  "ids" : [ "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908", "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70" ],
  "columns" : [ 1001, 1002 ],
  "category" : "table"
}

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档