Updated on 2025-12-23 GMT+08:00

Querying Subnet Tags

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vpc:subnets:listTags

    List

    subnet *

    -

    • vpc:subnetTags:get

    -

URI

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

subnet_id

Yes

Specifies the subnet ID that uniquely identifies the subnet.

If you use the management console, the value of this parameter is the Network ID value.

Request Parameters

None

Example Request

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

Parameter

Type

Description

key

String

  • Specifies the tag key.
  • Cannot be left blank.
  • Can contain a maximum of 128 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 255 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.