1
0
forked from docs/doc-exports
doc-exports/docs/vpn/api-ref/en_topic_0093011487.html
gtema 6b71b4a1fa Initial import of the VPN API document
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-12-07 13:22:09 +00:00

8.5 KiB

Querying VPN Resource Tags

Function

This interface is used to query tags of a specified VPN resource.

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 target resource ID.

Request Message

None

Response Message

Table 1 describes the response parameters.

Table 1 Response parameter

Parameter

Type

Description

tags

List<resource_tag>

Specifies the tag list.

Description of field resource_tag

Name

Type

Description

key

String

Specifies the tag key.

The parameter constraints are as follows:

  • 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
    • Special characters, including hyphens (-) and underscores (_)

value

String

Specifies the tag value.

The parameter constraints are as follows:

  • Can contain a maximum of 43 characters.
  • Can contain only the following character types:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including 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 section Common Returned Values.