更新时间:2026-01-12 GMT+08:00

批量添加或删除集群标签

功能介绍

该接口用于对集群批量添加或删除标签,方便用户对Elasticsearch集群、Logstash集群、OpenSearch集群的标签进行管理。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定批量添加或删除标签的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

resource_type

String

参数解释

集群资源类型,当前固定值为“css-cluster”,表示是集群类型。

约束限制

不涉及

取值范围

css-cluster:表示是集群类型。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释

集群标签操作类型。通过该属性标识当前所需的操作类型。

约束限制

不涉及

取值范围

  • create:批量添加标签。

  • delete:批量删除标签。

默认取值

不涉及

tags

Array of Tag objects

参数解释

集群标签列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表3 Tag

参数

是否必选

参数类型

描述

key

String

参数解释

集群标签的key值。

约束限制

  • key不能为空,长度为1~128个字符。

  • 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。

  • _sys_开头属于系统标签,租户不能使用。

  • key两头不能有空格字符。

取值范围

不涉及

默认取值

不涉及

value

String

参数解释

集群标签的value值。

约束限制

  • 长度为0~255个字符。

  • 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _.://=+-@。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:204

请求已成功。

请求示例

批量创建集群标签。

POST https://{Endpoint}/v1.0/{project_id}/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "K1",
    "value" : "V1"
  }, {
    "key" : "K2",
    "value" : "V2"
  } ]
}

响应示例

状态码

状态码

描述

204

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码