文档首页/分布式缓存服务 DCS/API参考 (联盟区域) /API V2（推荐）/标签管理/批量添加或删除标签
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

批量添加或删除标签

功能介绍

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

URI

POST /v2/{project_id}/dcs/{instance_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

参数解释：

操作标识。

约束限制：

不涉及。

取值范围：

  • create：创建实例标签。

  • delete：删除实例标签。

默认取值：

不涉及。

tags

是

Array of ResourceTag objects

参数解释：

标签列表。

约束限制：

不涉及。

表3 ResourceTag

参数

是否必选

参数类型

描述

key

是

String

参数解释：

标签键。

约束限制：

  • 对于同一资源键值唯一。

  • 长度不超过128个字符。

  • 标签的键必须唯一且输入不能为空。

取值范围：

不涉及。

默认取值：

不涉及。

value

否

String

参数解释：

标签值。

约束限制：

  • action为create时必选。action为delete时非必选。

  • 长度不超过255个字符。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：204

添加/删除标签成功。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

  • 为指定实例批量添加标签。

    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action

{
  "action" : "create",
  "tags" : [ {
    "value" : "2",
    "key" : "dcs001"
  }, {
    "value" : "4",
    "key" : "dcs003"
  } ]
}

  • 为指定实例批量删除标签。

    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action

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

响应示例

状态码：400

非法请求。

{
  "error_code" : "DCS.4005",
  "error_msg" : "The message body contains invalid characters or is not in JSON format."
}

状态码

状态码

描述

204

添加/删除标签成功。

400

非法请求。

401

认证失败。

403

请求被拒绝。

404

路径错误。

500

内部错误。

错误码

请参见错误码。

父主题：标签管理