doc-exports/docs/vpn/api-ref/vpn_api_1019.html
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

11 KiB

Querying VPN Tags

Function

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

URI

GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags

In the URI, project_id indicates the project ID, and resource_id indicates the ID of the target resource.

Request

None

Response

Table 1 describes the response parameter.

Table 1 Response parameter

Parameter

Type

Description

tags

List<resource_tag>

Specifies the list of tags.

Table 2 Description of field resource_tag

Name

Type

Description

key

String

Specifies the tag key.

The key

  • Must be unique for a resource.
  • Cannot be left blank.
  • Can contain a maximum of 36 characters.
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Hyphens (-) and underscores (_)

value

String

Specifies the tag value.

The value

  • Can contain a maximum of 43 characters.
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Hyphens (-) and underscores (_)

Example

  • Example request
    GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
  • Example response
    {
           "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

Returned Values

For details, see Common Returned Values.