文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 标签管理/ 批量添加或删除标签- BatchTagAction
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量添加或删除标签 - BatchTagAction

功能介绍

批量添加或删除指定实例的标签。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:tag:deal

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:dealTag

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

POST /v3/{project_id}/instances/{instance_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

参数解释：

标签操作标识。

约束限制：

不涉及。

取值范围：

  • create：表示添加标签。

  • delete：表示删除标签。

默认取值：

不涉及。

tags

是

Array of TagItem objects

参数解释：

标签列表。

约束限制：

不涉及。
表4 TagItem

参数

是否必选

参数类型

描述

key

是

String

参数解释：

标签键。

约束限制：

不涉及。

取值范围：

1-128个unicode字符，不能为null或者空字符串，不能为空格。字符集：0-9，A-Z，a-z，“_”，“-”，中文。

默认取值：

不涉及。

value

否

String

参数解释：

标签值。

约束限制：

  • “action”值为“create”时，该参数必选。

  • “action”值为“delete”时，如果value有值，按照key-value删除，如果value没值，则按照key删除。

取值范围：

0-255个unicode字符，可以为空字符串，不能为空格。字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。

默认取值：

不涉及。

响应参数

状态码：200

Success.

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 批量添加标签 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}
  • 批量删除标签 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags/action
{
  "action" : "delete",
  "tags" : [ {
    "key" : "key1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

响应示例

无

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 标签管理