Querying Tags in a Specified Project

Function

This API is used to query all tags of a tenant for a specified resource type in a specified project.

URI

  • URI format

    GET /v1.0/{project_id}/clusters/tags
    
  • Parameter description

    Table 1 URI parameter description

    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 Message

  • Sample request

    GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/tags
    
  • Parameter description

    None

Response Message

  • Sample response

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

    Table 2 Response parameter description

    Parameter

    Mandatory

    Type

    Description

    tags

    Yes

    List<tag>

    Tag list.

    Table 3 tag

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Key. A tag key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces.

    It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).

    values

    Yes

    List<String>

    Value. A tag value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. It can contain uppercase letters (A to Z), lowercase letters (a to z), digits (0-9), hyphens (-), and underscores (_).

Status Code

  • Normal

    200

  • Abnormal

    Table 4 Returned value for failed requests

    Returned Value

    Description

    400

    Invalid parameters.

    401

    Authentication failed.

    403

    You do not have the permission to perform the operation.

    404

    The requested resource was not found.

    500

    Internal service error.