Updated on 2022-11-18 GMT+08:00

Querying All Tags

Function

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

Constraints

None

Debugging

You can debug this API through automatic authentication in API Explorer. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

  • Format

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

  • Parameter description
    Table 1 URI parameter

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

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

Request Parameters

Request parameters

None

Response Parameters

Table 2 Response parameter

Parameter

Type

Description

tags

Array of TagWithMultiValue objects

Tag list. For details, see Table 3.

Table 3 tags parameters

Parameter

Type

Description

key

String

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

value

Array of strings

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

Example

  • Example request
    GET https://{endpoint}/v1.1/{project_id}/clusters/tags
  • Example response
    { 
        "tags": [ 
        { 
            "key": "key1", 
            "values": [ 
                "value1", 
                "value2" 
            ] 
            }, 
            { 
            "key": "key2", 
            "values": [ 
                "value1", 
                "value2" 
            ] 
            } 
        ] 
    } 
    

Status Codes

See Status Codes.

Error Codes

See Error Codes.