文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/标签管理/批量添加或删除资源标签
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

批量添加或删除资源标签

接口说明

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

约束说明

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

URI

  • URI格式

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

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 参数说明

名称

参数类型

是否必选

描述

action

String

是

操作标识。取值：

  • create，表示添加标签。
  • delete，表示删除标签。

tags

Array of objects

是

标签列表。详情请参见表4。

说明：

删除标签时，不对该参数做字符集校验。

表4 tags字段数据结构说明

名称

参数类型

是否必选

描述

key

String

是

标签键。

  • key不能为空，长度1~128个半角字符。
  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / =+ - @。
  • _sys_开头属于系统标签，租户不能输入。

value

String

否

标签值。

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / =+ - @。
  • 可以为空（empty or null），长度0~255个半角字符。

字符集：0-9，A-Z，a-z，“_”，“.”，“-”。

  • “action”值为“create”时，该参数必选。
  • “action”值为“delete”时，该参数可选。
    说明：

    删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

  • 请求示例

    添加标签：

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

    删除标签：

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

响应参数

{}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：标签管理