Help Center> Virtual Private Cloud> API Reference> APIs> VPC Tag Management> Querying VPC Tags in a Specified Project
View PDF

Querying VPC Tags in a Specified Project

Function

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

This API is available only in regions CN North-Beijing1, CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, CN South-Guiyang1, CN South-Guangzhou, and AP-Hong-Kong.

URI

GET /v2.0/{project_id}/vpcs/tags

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

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

Request Message

Request parameter

None

Example request

GET https://{Endpoint}/v2.0/{project_id}/vpcs/tags

Response Message

Response parameter

Table 2 Response parameter

Parameter

Type

Description

tags

Array of tag objects

Specifies the tag list.
Table 3 Description of the tag field

Name

Type

Description

key

String

Specifies the tag key.

  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • Can contain letters, digits, underscores (_), and hyphens (-).

values

Array of strings

Specifies the tag value list.

  • Can contain a maximum of 43 characters.
  • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).

Example response

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

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: VPC Tag Management