Updated on 2024-08-01 GMT+08:00

Querying VPC Tags

Function

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

URI

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

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

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 that uniquely identifies the VPC.

Request Parameters

None

Example Request

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

Response Parameters

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.
  • Contain up to 128 characters (36 characters on the console).
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a VPC must be unique.

value

String

  • Specifies the tag value.
  • Contain up to 255 characters (43 characters on the console).
  • 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.