Querying Resource Tags

Updated on 2024-04-03 GMT+08:00

View PDF

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

For details, see Calling APIs.

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.

Example request

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

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"
        }
    ]
}

For details, see Status Codes.

Parent topic: Tags

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel