Adding or Deleting Cluster Tags in Batches

Function

This API is used to add or delete tags to or from a specified cluster in batches.

You can add a maximum of 10 tags to a cluster.

This API is idempotent.

If a tag to be created has the same key as an existing tag in a cluster, the tag will overwrite the existing one.
When tags are being deleted and some tags do not exist, the operation is considered successful by default. The character set of the tags will not be checked. A key and a value can respectively contain up to 36 and 43 Unicode characters. When tags are deleted, the tag structure body cannot be missing, and the key cannot be left blank or set to an empty string.

Constraints

None

Debugging

You can debug this API through automatic authentication in API Explorer. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

Format
POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
cluster_id	Yes	String	Cluster ID For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Request Parameters

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Operation to be performed. The value can be set to create or delete only.
tags	Yes	Array of tag objects	Tag list. For details about the parameter, see Table 3.

**Table 3** tags parameters
Parameter	Mandatory	Type	Description
key	Yes	String	The tag key. The tag key cannot start or end with spaces or contain non-printable ASCII characters (0–31) and special characters (=*<>\,\|/). It contains a maximum of 36 Unicode characters and cannot be an empty string. The tag key of a resource must be unique.
value	Yes	String	The value. The tag value cannot start or end with spaces or contain non-printable ASCII characters (0–31) and special characters (=*<>\,\|/). The value contains a maximum of 43 Unicode characters and can be an empty string.

Response Parameters

Response parameters

None

Example

Example request for adding cluster tags in batches

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

Example request for deleting cluster tags in batches

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

{
  "action" : "delete",
  "tags" : [ {
    "tag" : null,
    "key" : "DEV1",
    "value" : "DEV1"
  }, {
    "tag" : null,
    "key" : "DEV2",
    "value" : "DEV2"
  } ],
  "x-request-examples-text-1" : "{\n    \"action\":\"create\",\n    \"tags\":[\n        {\n            \"key\":\"DEV1\",\n            \"value\":\"DEV1\"\n        }.{\n            \"key\":\"DEV2\",\n            \"value\":\"DEV2\"\n        }]\n}"
}