Updated on 2022-12-12 GMT+08:00

Querying Tags in a Specified Project

Description

This API is used to query all tags of instances in a specified project.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/tags

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/tags

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Requests

None

Responses

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    tags

    Yes

    Array of objects

    The tag list. For more information, see Table 3.

    Table 3 tags field data structure description

    Name

    Mandatory

    Type

    Description

    key

    Yes

    String

    The tag key. The value contains 36 Unicode characters and cannot be blank.

    Character set: 0-9, A-Z, a-z, "_", and "-".

    values

    Yes

    Array of strings

    Lists the tag values. The value contains a maximum of 43 Unicode characters and can also be an empty string.

    Character set: 0-9, A-Z, a-z, "_", and "-".

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

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.