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

Querying VPC Tags

Function

This API is used to query tags of a specified VPC.

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/{vpc_id}/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.

vpc_id

Yes

Specifies the VPC ID, which uniquely identifies the VPC.

Request Message

  • Request parameter

    None

  • Example request 
    GET https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags

Response Message

  • Response parameter
    Table 2 Response parameter

    Parameter

    Type

    Description

    tags

    Array of tag objects

    Specifies the tag object list. For details, see Table 3.
    Table 3 tag objects

    Attribute

    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 (-).
    • The tag key of a VPC must be unique.

    value

    String
    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
    • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).
  • Example response 
    {
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value3"
        }
    ]
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: VPC Tag Management