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

Querying Subnet Tags

Function

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

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

subnet_id

Yes

Specifies the subnet ID, which uniquely identifies the subnet.

Request Message

Request parameter

None

Example request

GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_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: Subnet Tag Management