Updated on 2024-11-29 GMT+08:00

Querying All Tags

Function

This API is used to query all tags of a specified region.

URI

GET /v1.1/{project_id}/clusters/tags
Table 1 URI parameter

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response parameter

Parameter

Type

Description

tags

Array of TagWithMultiValue objects

Explanation

Tag list. For details, see Table 3.

Table 3 tags 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

values

Array of strings

Explanation

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_.

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.