Help Center/ Virtual Private Network/ API Reference/ APIs of Enterprise Edition VPN/ Tags/ Querying Resource Tags
Updated on 2024-04-03 GMT+08:00
View PDF

Querying Resource Tags

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/{resource_type}/{resource_id}/tags

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

resource_type

String

Yes
  • Specifies the resource type.
  • The value can be vpn-gateway, customer-gateway, or vpn-connection.

resource_id

String

Yes

Indicates a resource ID.

Request

  • Request parameters

    None

  • Example request 
    GET https://{Endpoint}/v5/{project_id}/{resource_type}/{resource_id}/tags

Response

  • Response parameters

    Returned status code 200: successful query

    Table 2 Parameters in the response body

    Parameter

    Type

    Description

    tags

    Array of ResourceTag objects

    Specifies the list of resource tags.
    Table 3 ResourceTag

    Parameter

    Type

    Description

    key

    String

    Specifies a tag key.

    value

    String

    Specifies a tag value.
  • Example response 
    {
    "tags":[
        {
            "key":"key1",
            "value":"value1"
        }
    ]
}

Status Codes

For details, see Status Codes.

Parent topic: Tags