Hongwei, King Wang 32c06a10a2 vpn_api

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>

2024-08-15 14:18:28 +00:00

12 KiB

Raw Permalink Blame History

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.

**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

12 KiB Raw Permalink Blame History