批量添加或删除资源标签

接口说明

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

约束说明

• 一个文档数据库实例具有20个标签配额，且标签key唯一。
  • 添加标签时，如果请求体中存在重复key，调用该接口将会报错。
  • 添加标签时，如果请求体中的key与指定实例已有的key重复，将会覆盖已有key对应的value的值。
• 如果待删除的标签不存在，调用该接口将默认处理成功，删除时，不对标签字符集范围做校验。该场景下，要求请求体中tags结构体不能缺失，且key不能为空，或者空字符串。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags/action

请求消息

• 参数说明

  表2 参数说明

  名称	参数类型	是否必选	描述
  action	String	是	操作标识。取值： create，表示添加标签。 delete，表示删除标签。
  tags	Array of objects	是	标签列表。详情请参见表3。 说明： 删除标签时，不对该参数做字符集校验。

  表3 tags字段数据结构说明

  名称	参数类型	是否必选	描述
  key	String	是	标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。
  value	String	否	标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

请求示例

• 批量添加2个标签

  {
    "action": "create",
    "tags": [
      {
        "key": "key1",
        "value": "value1"
      },
      {
        "key": "key",
        "value": "value3"
      }
    ]
  }

• 批量删除2个标签

  {
    "action": "delete",
    "tags": [
      {
        "key": "key1"
      },
      {
        "key": "key2",
        "value": "value3"
      }
    ]
  }

响应消息

{}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。