Help Center/ MapReduce Service/ API Reference/ API V1.1/ Tag Management APIs/ Querying All Tags - ListAllTags
Updated on 2026-06-27 GMT+08:00
View PDF
Share

Querying All Tags - ListAllTags

Function

This API is used to query all tag collections of a tenant in a specified region.

Constraints

None

Debugging

You can debug this API in API Explorer, which supports automatic authentication and authorization. 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/tags
Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response parameter

Parameter

Type

Description

tags

Array of TagWithMultiValue objects

Definition

Tag list. For details, see Table 3.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 tags parameters

Parameter

Type

Description

key

String

Definition

Tag key.

Constraints

N/A

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

values

Array of strings

Definition

Tag value.

Constraints

A tag value can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

Range

N/A

Default Value

N/A

Example Request

Query all tags.

GET https://{endpoint}/v1.1/{project_id}/clusters/tags

Example Response

Status code: 200

The operation is successful.

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ]
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Tag Management APIs