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.1 KiB

Raw Blame History

Creating a Tag for a VPN Resource

Function

This interface is used to create a tag for a VPN resource.

URI

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

Table 1 describes the request parameters.

**Table 1** Request parameters
Parameter	Type	Mandatory	Description
tag	List<resource_tag>	Yes	Specifies the tag.

Description of field resource_tag

Name	Type	Mandatory	Description
key	String	Yes	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	Yes	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 (_)

Name

Type

Mandatory

Description

key

String

Yes

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

Yes

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

Response Message

None

Example

Example Request

POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
{
    "tag": {
        "key": "key1",
        "value": "value1"
    }
}

Example Response
None

Returned Values

For details, see section Common Returned Values.

Parent topic: Tag Management

9.1 KiB Raw Blame History