Help Center/ Cloud Search Service/ API Reference/ API V1/ Tag Management/ Adding or Deleting Cluster Tags in Batches

Updated on 2025-11-28 GMT+08:00

View PDF

Adding or Deleting Cluster Tags in Batches

Function

This API is used to add or delete tags in batches for Elasticsearch, Logstash, and OpenSearch clusters.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster for which you want to add or delete tags in batches. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A
resource_type	Yes	String	Definition: Cluster resource type. Currently, its value can only be css-cluster. Constraints: N/A Value range: css-cluster: Indicates the cluster type. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition: Cluster tag operation type. This attribute is used to identify the required operation type. Constraints: N/A Value range: create: Tags are added in batches. delete: Tags are deleted in batches. Default value: N/A
tags	Yes	Array of Tag objects	Definition: List of cluster tags. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Definition: Tag key. Constraints: The key cannot be empty. Its length is 1 to 128 characters. The value can contain UTF-8 letters, digits, spaces, and special characters _ . : = + - @. Tags starting with sys are system tags and cannot be used by tenants. Do not use spaces to start or end the key. Value range: N/A Default value: N/A
value	Yes	String	Definition: Tag value. Constraints: The value contains 0 to 255 characters. The value can contain UTF-8 letters, digits, spaces, and special characters _.://=+-@ Value range: N/A Default value: N/A

Response Parameters

Status code: 204

Request succeeded.

None

Example Requests

Create cluster tags in batches.

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"
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
204	Request succeeded.
400	Invalid request. Do not retry the request before modification.
409	The request could not be completed due to a conflict with the current state of the resource. This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.
412	The server did not meet one of the preconditions contained in the request.