批量添加或删除资源标签

功能介绍

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

接口约束

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

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	描述
  project_id	是	租户在某一region下的project ID。
  instance_id	是	实例ID。

请求消息

• 参数说明

  表2 参数说明

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

  表3 tags字段数据结构说明

  名称	是否必选	参数类型	描述
  key	是	String	标签键。最大长度36个unicode字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。 字符集：0-9，A-Z，a-z，“_”，“-”。
  value	否	String	标签值。最大长度43个unicode字符，可以为空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

• 请求头

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

• 请求体样例

  添加标签：

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

  删除标签：

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

响应消息

{}

状态码

详情请参见状态码。

错误码

详情请参见错误码。