Help Center/ Virtual Private Cloud/ API Reference/ APIs/ VPC Tag Management/ Querying VPC Tags in a Specified Project
Updated on 2024-07-17 GMT+08:00

Querying VPC Tags in a Specified Project

Function

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

URI

GET /v2.0/{project_id}/vpcs/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.

Request Parameters

None

Example Request

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

Response Parameters

Table 2 Response parameter

Parameter

Type

Description

tags

Array of tag objects

Specifies the tag list.

Table 3 Description of the tag field

Parameter

Type

Description

key

String

Specifies the tag key.

  • Cannot be left blank.
  • Contain up to 128 characters (36 characters on the console).
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including hyphens (-), underscores (_), and at signs (@)

values

Array of strings

Specifies the tag value list.

  • Contain up to 255 characters (43 characters on the console).
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including hyphens (-), underscores (_), and at signs (@)

Example Response

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

Status Code

See Status Codes.

Error Code

See Error Codes.