Updated on 2022-08-12 GMT+08:00

Adding a Tag to a Specified Cluster

Function

This API is used to add a tag to a specified cluster.

A cluster has a maximum of 10 tags. This API is idempotent. If a tag to be created has the same key as an existing tag, the tag will overwrite the existing one.

URI

  • Format

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

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

    cluster_id

    Yes

    Cluster ID

Request

Table 2 tags parameter description

Parameter

Mandatory

Type

Description

key

Yes

String

Key. A tag key cannot contain special characters (=*<>\,|/) or start or end with a space.

value

Yes

String

Tag value. A tag value cannot contain special characters (=*<>\,|/) or start or end with a space.

Response

Response parameters

None.

Example

  • Example request
{ 
    "tag": 
        { 
            "key":"DEV", 
            "value":"DEV1" 
        } 
} 
  • Example response

    None.

Status Code

Table 3 describes the status code of this API.

Table 3 Status code

Status Code

Description

204

The operation is successful.