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

9.4 KiB

Raw Blame History

Querying VPN Tags in a Specified Project

Function

This interface is used to query all tags of a VPN in a specified region.

URI

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

In the URI, project_id indicates the project ID.

Request Message

None

Response Message

Table 1 describes the response parameters.

**Table 1** Response parameter
Parameter	Type	Description
tags	List<tag>	Specifies the tag list.

Description of field tag

Name	Type	Description
key	String	Specifies the tag key. The parameter constraints are as follows: 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 (_)
values	List<String>	Specifies the tag value list. 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 (_)

Name

Type

Description

key

String

Specifies the tag key.

The parameter constraints are as follows:

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 (_)

values

List<String>

Specifies the tag value list.

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/tags

Example Response

{
    "tags": [
        {
            "key": "key1",
            "values": [
                "value1",
                "value2"
            ]
        },
        {
            "key": "key2",
            "values": [
                "value1",
                "value2"
            ]
        }
    ]
}

Returned Values

For details, see section Common Returned Values.

Parent topic: Tag Management

9.4 KiB Raw Blame History