Help Center/ MapReduce Service/ API Reference/ API V1.1/ Tag Management APIs/ Adding Tags to a Specified Cluster
Updated on 2024-09-30 GMT+08:00
View PDF
Share

Adding Tags to a Specified Cluster

Function

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

A cluster has a maximum of 20 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.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. 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

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Explanation

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

    Constraints

    N/A

    Value range

    The value must consist of 1 to 64 characters. Only letters and digits are allowed.

    Default value

    N/A

    cluster_id

    Yes

    String

    Explanation

    Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

    Constraints

    N/A

    Value range

    The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

    Default value

    N/A

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

tag

Yes

Tag object

Explanation

Cluster tag.

Constraints

N/A
Table 3 tags parameters

Parameter

Mandatory

Type

Description

key

Yes

String

Explanation

Tag key.

Constraints

N/A

Value range

  • The value can contain a maximum of 128 characters and cannot be an empty string.
  • The tag key of a resource must be unique.
  • A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

Default value

N/A

value

Yes

String

Explanation

Tag value.

Constraints

N/A

Value range

  • The value can contain a maximum of 255 characters and can be an empty string.
  • A tag value can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

Default value

N/A

Response Parameters

None

Example Request

Add a tag to a specified cluster.

{ 
    "tag": 
        { 
            "key":"DEV", 
            "value":"DEV1" 
        } 
}

Example response

None

Status Codes

Table 4 describes the status code.

Table 4 Status code

Status Code

Description

204

The operation is successful.

Error Codes

See Error Codes.

Parent topic: Tag Management APIs