Help Center/MapReduce Service/API Reference/API V1.1/Tag Management APIs/Querying Tags of a Specified Cluster - ListClusterTags
Updated on 2026-01-04 GMT+08:00
View PDF
Share

Querying Tags of a Specified Cluster - ListClusterTags

Function

This API is used to query tags of a specified cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v1.1/{project_id}/clusters/{cluster_id}/tags
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

None

Response Parameters

Status code: 200

Table 2 Response parameter

Parameter

Type

Description

tags

Array of TagPlain objects

Explanation

Tag list. For details, see Table 3.

Constraints

N/A

Value range

N/A

Default value

N/A

Table 3 TagPlain parameters

Parameter

Type

Description

key

String

Explanation

Tag key.

Constraints

N/A

Value range

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

String

Explanation

Tag value.

Constraints

N/A

Value range

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

Example Request

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

Example Response

Status code: 200

The operation is successful.

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

Status Codes

Table 4 describes the status code.

Table 4 Status code

Status Code

Description

200

The operation is successful.

Error Codes

See Error Codes.

Parent topic:Tag Management APIs