nav-img
Advanced

Adding Resource Tags to a Specified Cluster in Batches

Function

This API is used to add resource tags for a specified cluster in batches.

Note
  • Each cluster supports a maximum of 20 resource tags.
  • This API is idempotent. If the to-be-added tag has the same tag key and tag value as an existing tag, the tag will be added. If the to-be-added tag has the same key but different value as an existing tag, the tag will overwrite the existing one.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of ResourceTag objects

List of cluster resource tags to be created. Each cluster supports a maximum of 20 resource tags.

Table 4 ResourceTag

Parameter

Mandatory

Type

Description

key

No

String

Key.

  • Cannot be null. Max characters: 128.
  • Use letters, digits, and spaces in UTF-8 format.
  • Can contain the following special characters: _.:/=+-@.
  • Cannot start with _sys_.

value

No

String

Value.

  • Can be null but not the default. Max characters: 255.
  • Use letters, digits, and spaces in UTF-8 format.
  • Can contain the following special characters: _.:/=+-@.

Response Parameters

None

Example Requests

Adding Resource Tags to a Specified Cluster in Batches

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/create
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value3"
} ]
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

Error Codes