Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Adding or Deleting Cluster Tags in Batches
Updated on 2025-08-15 GMT+08:00

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

SDK Sample Code

The SDK sample code is as follows.

Java

Create cluster tags in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateBatchClustersTagsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateBatchClustersTagsRequest request = new UpdateBatchClustersTagsRequest();
        request.withClusterId("{cluster_id}");
        request.withResourceType("{resource_type}");
        BatchAddOrDeleteTagOnClusterReq body = new BatchAddOrDeleteTagOnClusterReq();
        List<Tag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new Tag()
                .withKey("K1")
                .withValue("V1")
        );
        listbodyTags.add(
            new Tag()
                .withKey("K2")
                .withValue("V2")
        );
        body.withTags(listbodyTags);
        body.withAction("create");
        request.withBody(body);
        try {
            UpdateBatchClustersTagsResponse response = client.updateBatchClustersTags(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Create cluster tags in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateBatchClustersTagsRequest()
        request.cluster_id = "{cluster_id}"
        request.resource_type = "{resource_type}"
        listTagsbody = [
            Tag(
                key="K1",
                value="V1"
            ),
            Tag(
                key="K2",
                value="V2"
            )
        ]
        request.body = BatchAddOrDeleteTagOnClusterReq(
            tags=listTagsbody,
            action="create"
        )
        response = client.update_batch_clusters_tags(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Create cluster tags in batches.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateBatchClustersTagsRequest{}
	request.ClusterId = "{cluster_id}"
	request.ResourceType = "{resource_type}"
	var listTagsbody = []model.Tag{
        {
            Key: "K1",
            Value: "V1",
        },
        {
            Key: "K2",
            Value: "V2",
        },
    }
	request.Body = &model.BatchAddOrDeleteTagOnClusterReq{
		Tags: listTagsbody,
		Action: "create",
	}
	response, err := client.UpdateBatchClustersTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.

Error Codes

See Error Codes.