Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+
Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+
For details about how to use APIs, see API Usage Guidelines.
+
VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.
+
A combination of these two types of APIs allows you to use all functions provided by the VPN service.
+
+
Table 1 VPN APIsCategory
+ |
+Sub-Category
+ |
+Description
+ |
+
|---|
+
+Native OpenStack API
+ |
+IPsec connection management
+ |
+APIs for creating, querying, modifying, and deleting IPsec connections
+ |
+
+VPN service management
+ |
+APIs for creating, querying, modifying, and deleting VPN services
+ |
+
+IPsec policy management
+ |
+APIs for creating, querying, modifying, and deleting IPsec policies
+ |
+
+IKE policy management
+ |
+APIs for creating, querying, modifying, and deleting IKE policies
+ |
+
+VPN endpoint group management
+ |
+APIs for creating, querying, modifying, and deleting VPN endpoint groups
+ |
+
+VPN API
+ |
+Tag management
+ |
+APIs for creating, querying, and deleting tags, and querying VPN resources by tags
+ |
+
+
+
+
+
The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the VPN service APIs.
+
Function
This API is used to query all available versions of a native OpenStack API.
+
+
+
Request Message
Request parameter
+
None
+
Example request
+
GET https://{Endpoint}/
+
+
Response Message
Response parameter
+
+
Table 1 Response parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+versions
+ |
+Array of version objects
+ |
+Specifies the API version list. For details, see Table 2.
+ |
+
+
+
+
+
+
Table 2 version objectsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+status
+ |
+String
+ |
+Specifies the API version status. Possible values are as follows:
+
+ |
+
+id
+ |
+String
+ |
+Specifies the API version.
+ |
+
+links
+ |
+Array of link objects
+ |
+Specifies the link list. For details, see Table 3.
+ |
+
+
+
+
+
+
Table 3 link objectsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+href
+ |
+String
+ |
+Specifies the API link.
+ |
+
+rel
+ |
+String
+ |
+Specifies the relationship between the API link and the API version.
+ |
+
+
+
+
+
Example response
+
{
+ "versions": [
+ {
+ "status": "CURRENT",
+ "id": "v2.0",
+ "links": [
+ {
+ "href": "https://None/v2.0",
+ "rel": "self"
+ }
+ ]
+ }
+ ]
+}
+
+
+
+
Function
This interface is used to query VPN resource instances by tag.
+
Tag Management Service (TMS) uses this API to filter out service resources and display them in a list. These services must have the query capabilities.
+
+
URI
POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+tags
+ |
+List<tag>
+ |
+No
+ |
+Specifies the included tags. Each tag contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique.
+ |
+
+limit
+ |
+Integer
+ |
+No
+ |
+Sets the page size. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.
+ |
+
+offset
+ |
+Integer
+ |
+No
+ |
+Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.
+ |
+
+action
+ |
+String
+ |
+Yes
+ |
+Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number).
+The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.
+ |
+
+matches
+ |
+List<match>
+ |
+No
+ |
+Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the value to be matched. The key field is a fixed dictionary value.
+ |
+
+
+
+
+
+
+
Name
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+key
+ |
+String
+ |
+Yes
+ |
+Specifies the tag key. It contains a maximum of 127 Unicode characters. It cannot be left blank. (This parameter is not verified in the search process.)
+ |
+
+values
+ |
+List<String>
+ |
+Yes
+ |
+Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The resources containing one or more values listed in values will be found and displayed.
+ |
+
+
+
+
+
- Description of field match
+
+
Name
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+key
+ |
+String
+ |
+Yes
+ |
+Specifies the tag key. Currently, the tag key can only be the resource name.
+ |
+
+value
+ |
+String
+ |
+Yes
+ |
+Specifies the tag value. Each value can contain a maximum of 255 Unicode characters.
+ |
+
+
+
+
+
+
Response Parameter
Table 2 describes the response parameters.
+
Table 2 Response Parameter
+
+
+
+
+
+
Name
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resources
+ |
+List<resource>
+ |
+N/A
+ |
+
+total_count
+ |
+int
+ |
+Specifies the total number of records.
+ |
+
+
+
+
+
+
Table 3 Description of field resourceName
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resource_id
+ |
+String
+ |
+Specifies the resource ID.
+ |
+
+resouce_detail
+ |
+Object
+ |
+Specifies the resource details. The value is a resource object, used for extension. This parameter is left blank by default.
+ |
+
+tags
+ |
+List<resource_tag>
+ |
+Specifies the tag list. This parameter is an empty array by default if there is no tag.
+ |
+
+resource_name
+ |
+String
+ |
+Specifies the resource name. This parameter is an empty string by default if there is no resource name.
+ |
+
+
+
+
+
+
+
Example
- Request Example
POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action
+ - Request Body
- Request body when action is set to filter
+{
+ "offset": "0",
+ "limit": "100",
+ "action": "filter",
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ }
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "*value1",
+ "value2"
+ ]
+ }
+ ]
+}
+- Request body when action is set to count
+{
+ "action": "count",
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ },
+ {
+ "key": "key2",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ],
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ }
+ ]
+}
+ - Example Response
- Response body when action is set to filter
+{
+ "resources": [
+ {
+ "resource_detail": null,
+ "resource_id": "cdfs_cefs_wesas_12_dsad",
+ "resource_name": "resouece1",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value1"
+ }
+ ]
+ }
+ ],
+ "total_count": 1000
+}
+
+- Response body when action is set to count
+{
+ "total_count": 1000
+}
+
+
+
Function
This interface is used to add multiple tags to or delete multiple tags from a VPN resource instance at a time.
+
This API is idempotent.
+
If there are duplicate keys in the request body when you add tags, an error is reported.
+
During tag creation, duplicate keys are not allowed. If a key exists in the database, its value will be overwritten.
+
During tag deletion, if some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.
+
+
URI
POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/action
+
In the URI, project_id indicates the project ID, and resource_id indicates the target resource ID.
+
+
+
Request Parameter
+
Parameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+tags
+ |
+List<resource_tag>
+ |
+Yes
+ |
+Specifies the tag list. A tag list can contain a maximum of 10 keys.
+ |
+
+action
+ |
+String
+ |
+Yes
+ |
+Specifies the operation to perform. The value can be create or delete.
+ |
+
+
+
+
+
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
+
+ |
+(This parameter is mandatory when action is set to create and optional when action is set to delete.)
+ |
+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 (_)
+
+ |
+
+
+
+
+
+
+
+
Request Body
{
+ "action": "create",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key",
+ "value": "value3"
+ }
+ ]
+}
+
Or
+
{
+ "action": "delete",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value3"
+ }
+ ]
+}
+
+
+
+
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 parametersParameter
+ |
+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 (_)
+
+ |
+
+
+
+
+
+
+
+
POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
+{
+ "tag": {
+ "key": "key1",
+ "value": "value1"
+ }
+}
+
+
+
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.
+
+
+
+
Response Message
Table 1 describes the response parameters.
+
+
Table 1 Response parameterParameter
+ |
+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 Response
{
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value3"
+ }
+ ]
+}
+
+
+
Function
This interface is used to delete a VPN resource tag.
+
+
URI
DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}
+
In the URI, project_id indicates the project ID, resource_id indicates the target resource ID, and key indicates the tag key to be deleted.
+
+
+
+
+
+
+
+
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.
+
+
+
+
Response Message
Table 1 describes the response parameters.
+
+
Table 1 Response parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tags
+ |
+List<tag>
+ |
+Specifies the tag list.
+ |
+
+
+
+
+
+
+
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 Response
{
+ "tags": [
+ {
+ "key": "key1",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ },
+ {
+ "key": "key2",
+ "values": [
+ "value1",
+ "value2"
+ ]
+ }
+ ]
+}
+
+
+
Function
This interface is used to create an IPsec VPN connection.
+
+
URI
POST /v2.0/vpn/ipsec-site-connections
+
+
Request Message
Table 1 lists the request parameters for creating an IPsec site connection.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+dpd
+ |
+Object
+ |
+No
+ |
+Specifies the DPD protocol control.
+ |
+
+local_id
+ |
+String
+ |
+No
+ |
+Specifies the ID of the external gateway address of a virtual router.
+ |
+
+psk
+ |
+String
+ |
+Yes
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+No
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+ipsecpolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec policy ID.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+No
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+mtu
+ |
+Integer
+ |
+No
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+Yes
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+ikepolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IKE policy ID.
+ |
+
+vpnservice_id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+local_ep_group_id
+ |
+String
+ |
+Yes
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+peer_address
+ |
+String
+ |
+Yes
+ |
+Specifies the remote gateway address.
+ |
+
+peer_id
+ |
+String
+ |
+Yes
+ |
+Specifies the remote gateway ID.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the IPsec VPN connection.
+ |
+
+auth_mode
+ |
+String
+ |
+No
+ |
+Specifies the authentication mode. The default value is psk.
+ |
+
+peer_cidrs
+ |
+List<String>
+ |
+No
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+
+
+
+
- The project_id, peer_id, dpd, and local_id parameters are not supported.
- The value of tenant_id can contain a maximum of 255 characters.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter.
- The value of peer_address can contain a maximum of 250 characters.
- The value of peer_id can contain a maximum of 250 characters and is unconfigurable.
- The route_mode parameter cannot be configured. The default value is static.
- The value of mtu can only be 1500.
- The value of initiator can only be bi-directional.
- The value of auth_mode can only be psk.
- The value of admin_state_up can only be true.
- A PSK can contain 6 to 128 characters. Spaces and question marks (?) are not allowed in a PSK. The PSK cannot contain only asterisks (*).
- To enable two IPsec connections to work in active/standby mode, the local_ep_group_id and peer_ep_group_id parameters of the active and standby connections must be set to the same value. If the parameter values are different and the local_ep_group and peer_ep_group values are different, the connection cannot work in active/standby mode.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+interval
+ |
+Integer
+ |
+Specifies the DPD interval in seconds. The default value is 30.
+ |
+
+dpd
+ |
+Object
+ |
+Specifies the DPD protocol control.
+ |
+
+psk
+ |
+String
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+ipsecpolicy_id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+mtu
+ |
+Integer
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+ikepolicy_id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+vpnservice_id
+ |
+String
+ |
+Specifies the VPN service ID.
+ |
+
+local_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+peer_address
+ |
+String
+ |
+Specifies the remote gateway address.
+ |
+
+peer_id
+ |
+String
+ |
+Specifies the remote gateway ID.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec VPN connection.
+ |
+
+auth_mode
+ |
+String
+ |
+Specifies the authentication mode. The default value is psk.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+route_mode
+ |
+String
+ |
+Specifies the route advertising mode. The default value is static.
+ |
+
+status
+ |
+String
+ |
+Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+peer_cidrs
+ |
+List
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+timeout
+ |
+Integer
+ |
+Specifies the DPD timeout. The default value is 120 seconds.
+ |
+
+action
+ |
+String
+ |
+Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.
+ |
+
+created_at
+ |
+String
+ |
+Specifies the time when the IPsec connection was created.
+ |
+
+
+
+
+
+
Example
- Example Request
POST /v2.0/vpn/ipsec-site-connections
+{
+ "ipsec_site_connection" : {
+ "psk" : "secret",
+ "initiator" : "bi-directional",
+ "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
+ "admin_state_up" : true,
+ "mtu" : 1500,
+ "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
+ "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
+ "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
+ "peer_address" : "172.24.4.233",
+ "peer_id" : "172.24.4.233",
+ "name" : "vpnconnection1"
+ }
+}
+
+
+
- Example Response
{
+ "ipsec_site_connection" : {
+ "status" : "PENDING_CREATE",
+ "psk" : "secret",
+ "initiator" : "bi-directional",
+ "name" : "vpnconnection1",
+ "admin_state_up" : true,
+ "tenant_id" : "10039663455a446d8ba2cbb058b0f578",
+ "auth_mode" : "psk",
+ "peer_cidrs" : [ ],
+ "mtu" : 1500,
+ "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
+ "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
+ "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "dpd" : {
+ "action" : "hold",
+ "interval" : 30,
+ "timeout" : 120
+ },
+ "route_mode" : "static",
+ "vpnservice_id": "4754261f-f8c5-4799-a365-78b2e682e38a",
+ "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
+ "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
+ "peer_address" : "172.24.4.233",
+ "created_at": "2018-11-03 14:24:33.749714",
+ "peer_id" : "172.24.4.233",
+ "id" : "851f280f-5639-4ea3-81aa-e298525ab74b",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query details about an IPsec VPN connection.
+
+
URI
GET /v2.0/vpn/ipsec-site-connections/{connection_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+connection_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+
+
+
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+local_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+status
+ |
+String
+ |
+Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+psk
+ |
+String
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+admin_state_up
+ |
+Boo
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+ipsecpolicy_id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+auth_mode
+ |
+String
+ |
+Specifies the authentication mode. The default value is psk.
+ |
+
+peer_cidrs
+ |
+List<String>
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+mtu
+ |
+Integer
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+ikepolicy_id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+peer_address
+ |
+String
+ |
+Specifies the remote gateway address.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+ipsec_site_connection
+ |
+Object
+ |
+Specifies the IPsec VPN connection object.
+ |
+
+route_mode
+ |
+String
+ |
+Specifies the route advertising mode. The default value is static.
+ |
+
+peer_id
+ |
+String
+ |
+Specifies the remote gateway ID.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec VPN connection.
+ |
+
+interval
+ |
+Integer
+ |
+Specifies the DPD interval in seconds. The default value is 30.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+dpd
+ |
+Object
+ |
+Specifies the DPD protocol control.
+ |
+
+timeout
+ |
+Integer
+ |
+Specifies the DPD timeout. The default value is 120 seconds.
+ |
+
+action
+ |
+String
+ |
+Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.
+ |
+
+vpnservice_id
+ |
+String
+ |
+Specifies the VPN service ID.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ipsec_site_connection" : {
+ "status" : "DOWN",
+ "psk" : "secret",
+ "initiator" : "bi-directional",
+ "name" : "vpnconnection1",
+ "admin_state_up" : true,
+ "project_id" : "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id" : "10039663455a446d8ba2cbb058b0f578",
+ "auth_mode" : "psk",
+ "peer_cidrs" : [ ],
+ "mtu" : 1500,
+ "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
+ "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
+ "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "dpd" : {
+ "action" : "hold",
+ "interval" : 30,
+ "timeout" : 120
+ },
+ "route_mode" : "static",
+ "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
+ "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
+ "peer_address" : "172.24.4.226",
+ "peer_id" : "172.24.4.226",
+ "id" : "851f280f-5639-4ea3-81aa-e298525ab74b",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query IPsec VPN connections.
+
+
URI
GET /v2.0/vpn/ipsec-site-connections
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+fields
+ |
+String
+ |
+No
+ |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.
+ |
+
+
+
+
+
The project_id, peer_id, dpd, and local_id parameters are not supported.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+peer_cidrs
+ |
+List<String>
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+mtu
+ |
+Integer
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+ikepolicy_id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+dpd
+ |
+Object
+ |
+Specifies the DPD protocol control.
+ |
+
+route_mode
+ |
+String
+ |
+Specifies the route advertising mode. The default value is static.
+ |
+
+peer_address
+ |
+String
+ |
+Specifies the remote gateway address.
+ |
+
+peer_id
+ |
+String
+ |
+Specifies the remote gateway ID.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec VPN connection.
+ |
+
+project_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+interval
+ |
+Integer
+ |
+Specifies the DPD interval in seconds. The default value is 30.
+ |
+
+timeout
+ |
+Integer
+ |
+Specifies the DPD timeout. The default value is 120 seconds.
+ |
+
+action
+ |
+String
+ |
+Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.
+ |
+
+vpnservice_id
+ |
+String
+ |
+Specifies the VPN service ID.
+ |
+
+local_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+status
+ |
+String
+ |
+Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+psk
+ |
+String
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+ipsecpolicy_id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+auth_mode
+ |
+String
+ |
+Specifies the authentication mode. The default value is psk.
+ |
+
+
+
+
+
+
Example Request
GET /v2.0/vpn/ipsec-site-connections
+
+
Example Response
{
+ "ipsec_site_connections" : [ {
+ "status" : "PENDING CREATE",
+ "psk" : "secret",
+ "initiator" : "bi-directional",
+ "name" : "vpnconnection1",
+ "admin_state_up" : true,
+ "project_id" : "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id" : "10039663455a446d8ba2cbb058b0f578",
+ "auth_mode" : "psk",
+ "peer_cidrs" : [ ],
+ "mtu" : 1500,
+ "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
+ "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
+ "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "dpd" : {
+ "action" : "hold",
+ "interval" : 30,
+ "timeout" : 120
+ },
+ "route_mode" : "static",
+ "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
+ "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68",
+ "peer_address" : "172.24.4.226",
+ "peer_id" : "172.24.4.226",
+ "id" : "851f280f-5639-4ea3-81aa-e298525ab74b",
+ "description" : ""
+ } ]
+}
+
+
+
Function
This interface is used to update an IPsec VPN connection.
+
+
URI
PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+connection_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+
+
+
+
+
Request Message
Table 2 describes the request parameters.
+
+
Table 2 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ipsec_site_connection
+ |
+Object
+ |
+Yes
+ |
+Specifies the IPsec VPN connection object.
+ |
+
+psk
+ |
+String
+ |
+No
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+No
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Specifies the IPsec policy ID.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+No
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+interval
+ |
+Integer
+ |
+No
+ |
+Specifies the DPD interval in seconds. The default value is 30.
+ |
+
+peer_cidrs
+ |
+List<String>
+ |
+No
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+mtu
+ |
+Integer
+ |
+No
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+No
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+local_ep_group_id
+ |
+String
+ |
+No
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+dpd
+ |
+Object
+ |
+No
+ |
+Specifies the DPD protocol control.
+ |
+
+timeout
+ |
+Integer
+ |
+No
+ |
+Specifies the DPD timeout. The default value is 120 seconds.
+ |
+
+action
+ |
+String
+ |
+No
+ |
+Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.
+ |
+
+peer_address
+ |
+String
+ |
+Yes
+ |
+Specifies the remote gateway address.
+ |
+
+peer_id
+ |
+String
+ |
+Yes
+ |
+Specifies the remote gateway ID.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+
+
+
+
- The project_id, peer_id, dpd, and local_id parameters are not supported.
- The connection_id parameter must be specified.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter.
- The value of peer_address can contain a maximum of 250 characters.
- The value of peer_id can contain a maximum of 250 characters and is unconfigurable.
- The value of mtu can only be 1500.
- The value of initiator can only be bi-directional.
- The value of admin_state_up can only be true.
- A PSK can contain 6 to 128 characters. Spaces and question marks (?) are not allowed in a PSK. The PSK cannot contain only asterisks (*).
+
+
+
Response Message
Table 3 describes the response parameters.
+
+
Table 3 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+status
+ |
+String
+ |
+Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+psk
+ |
+String
+ |
+Specifies the pre-shared key.
+ |
+
+initiator
+ |
+String
+ |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec VPN connection name.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+ipsecpolicy_id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+auth_mode
+ |
+String
+ |
+Specifies the authentication mode. The default value is psk.
+ |
+
+peer_cidrs
+ |
+String
+ |
+(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >.
+ |
+
+mtu
+ |
+Integer
+ |
+Specifies the maximum transmission unit to address fragmentation.
+ |
+
+peer_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (tenant CIDR blocks).
+ |
+
+ikepolicy_id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+dpd
+ |
+Object
+ |
+Specifies the DPD protocol control.
+ |
+
+route_mode
+ |
+String
+ |
+Specifies the route advertising mode. The default value is static.
+ |
+
+vpnservice_id
+ |
+String
+ |
+Specifies the VPN service ID.
+ |
+
+local_ep_group_id
+ |
+String
+ |
+Specifies the endpoint group ID (VPC subnets).
+ |
+
+peer_address
+ |
+String
+ |
+Specifies the remote gateway address.
+ |
+
+peer_id
+ |
+String
+ |
+Specifies the remote gateway ID.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec VPN connection.
+ |
+
+ipsec_site_connection
+ |
+Object
+ |
+Specifies the IPsec VPN connection object.
+ |
+
+project_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+interval
+ |
+Integer
+ |
+Specifies the DPD interval in seconds. The default value is 30.
+ |
+
+timeout
+ |
+Integer
+ |
+Specifies the DPD timeout. The default value is 120 seconds.
+ |
+
+action
+ |
+String
+ |
+Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ipsec_site_connection": {
+ "status": "DOWN",
+ "psk": "secret",
+ "initiator": "bi-directional",
+ "name": "vpnconnection1",
+ "admin_state_up": true,
+ "project_id": "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id": "10039663455a446d8ba2cbb058b0f578",
+ "auth_mode": "psk",
+ "peer_cidrs": [],
+ "mtu": 1200,
+ "peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1",
+ "ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f",
+ "vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "dpd": {
+ "action": "hold",
+ "interval": 30,
+ "timeout": 120
+ },
+ "route_mode": "static",
+ "ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1",
+ "local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68",
+ "peer_address": "172.24.4.233",
+ "peer_id": "172.24.4.233",
+ "id": "851f280f-5639-4ea3-81aa-e298525ab74b",
+ "description": "New description"
+ }
+}
+
+
+
Function
This interface is used to delete an IPsec VPN connection.
+
+
URI
DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+connection_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec VPN connection ID.
+ |
+
+
+
+
+
+
+
+
+
+
+
Function
This interface is used to create a VPN service.
+
Only one VPN service can be created for each VPC.
+
+
+
URI
POST /v2.0/vpn/vpnservices
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+subnet_id
+ |
+String
+ |
+No
+ |
+Specifies the subnet ID.
+ |
+
+router_id
+ |
+String
+ |
+Yes
+ |
+Specifies the router ID.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN service name.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+No
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN service.
+ |
+
+vpnservice
+ |
+Object
+ |
+Yes
+ |
+Specifies the VPN service object.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of tenant_id can contain a maximum of 255 characters.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of router_id must be the VPC router ID.
- The value of admin_state_up can only be true.
- This interface cannot be used to create a VPN service in the active-active VPN scenarios.
- Bandwidth limiting is used by default. The recommended bandwidth is 300 Mbit/s. This interface cannot be used to change the bandwidth size.
- In standalone mode, only one VPC service can be created for each VPN. In active-active mode, two VPC services can be created for each VPN.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+router_id
+ |
+String
+ |
+Specifies the router ID.
+ |
+
+status
+ |
+String
+ |
+Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+name
+ |
+String
+ |
+Specifies the VPN service name.
+ |
+
+external_v6_ip
+ |
+String
+ |
+Specifies the IPv6 address of the VPN service external gateway.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+subnet_id
+ |
+String
+ |
+Specifies the subnet ID.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+external_v4_ip
+ |
+String
+ |
+Specifies the IPv4 address of the VPN service external gateway.
+ |
+
+id
+ |
+String
+ |
+Specifies the VPN service ID.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the VPN service.
+ |
+
+vpnservice
+ |
+Object
+ |
+Specifies the VPN service object.
+ |
+
+
+
+
+
+
Example
- Example Request
POST /v2.0/vpn/vpnservices
+{
+ "vpnservice": {
+ "subnet_id": null,
+ "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
+ "name": "myservice",
+ "admin_state_up": true
+ }
+}
+
+
+
- Example Response
{
+ "vpnservice" : {
+ "router_id" : "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
+ "status" : "PENDING_CREATE",
+ "name" : "myservice",
+ "external_v6_ip" : "2001:db8::1",
+ "admin_state_up" : true,
+ "subnet_id" : null,
+ "project_id" : "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id" : "10039663455a446d8ba2cbb058b0f578",
+ "external_v4_ip" : "172.32.1.11",
+ "id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query details about a VPN service.
+
+
URI
GET /v2.0/vpn/vpnservices/{service_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+service_id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+
+
+
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+status
+ |
+String
+ |
+Yes
+ |
+Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+router_id
+ |
+String
+ |
+Yes
+ |
+Specifies the router ID.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN service name.
+ |
+
+external_v6_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv6 address of the VPN service external gateway.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+No
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+subnet_id
+ |
+String
+ |
+No
+ |
+Specifies the subnet ID.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+external_v4_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv4 address of the VPN service external gateway.
+ |
+
+id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN service.
+ |
+
+vpnservice
+ |
+Object
+ |
+Yes
+ |
+Specifies the VPN service object.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "vpnservice": {
+ "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
+ "status": "PENDING_CREATE",
+ "name": "myservice",
+ "external_v6_ip": "2001:db8::1",
+ "admin_state_up": true,
+ "subnet_id": null,
+ "project_id": "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id": "10039663455a446d8ba2cbb058b0f578",
+ "external_v4_ip": "172.32.1.11",
+ "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "description": "",
+ }
+}
+
+
+
Function
This interface is used to query VPN services.
+
+
URI
GET /v2.0/vpn/vpnservices
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+fields
+ |
+String
+ |
+No
+ |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.
+ |
+
+
+
+
+
The project_id parameter is not supported.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+vpnservices
+ |
+List<Object>
+ |
+Yes
+ |
+Specifies the VPN service object.
+ |
+
+status
+ |
+String
+ |
+Yes
+ |
+Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+router_id
+ |
+String
+ |
+Yes
+ |
+Specifies the router ID.
+ |
+
+name
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service name.
+ |
+
+external_v6_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv6 address of the VPN service external gateway.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Yes
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+subnet_id
+ |
+String
+ |
+No
+ |
+Specifies the subnet ID.
+ |
+
+tenant_id
+ |
+String
+ |
+Yes
+ |
+Specifies the project ID.
+ |
+
+external_v4_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv4 address of the VPN service external gateway.
+ |
+
+id
+ |
+String
+ |
+No
+ |
+Specifies the VPN service ID.
+ |
+
+description
+ |
+String
+ |
+Yes
+ |
+Provides supplementary information about the VPN service.
+ |
+
+
+
+
+
+
Example
+
GET /v2.0/vpn/vpnservices
+
+
- Example Response
{
+ "vpnservices": [
+ {
+ "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa",
+ "status": "PENDING_CREATE",
+ "name": "myservice",
+ "external_v6_ip": "2001:db8::1",
+ "admin_state_up": true,
+ "subnet_id": null,
+ "project_id": "10039663455a446d8ba2cbb058b0f578",
+ "tenant_id": "10039663455a446d8ba2cbb058b0f578",
+ "external_v4_ip": "172.32.1.11",
+ "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828",
+ "description": "",
+ }
+ ]
+}
+
+
+
Function
This interface is used to update a VPN service.
+
+
URI
PUT /v2.0/vpn/vpnservices/{service_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+service_id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+
+
+
+
+
Request Message
Table 2 describes the request parameters.
+
+
Table 2 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN service.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN service name.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+No
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+vpnservice
+ |
+Object
+ |
+Yes
+ |
+Specifies the VPN service object.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of admin_state_up can only be true.
- The subnet_id parameter is unconfigurable.
+
+
+
Response Message
Table 3 describes the response parameters.
+
+
Table 3 Response parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+router_id
+ |
+String
+ |
+Yes
+ |
+Specifies the router ID.
+ |
+
+status
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_UPDATE, or PENDING_DELETE.
+ |
+
+name
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service name.
+ |
+
+external_v6_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv6 address of the VPN service external gateway.
+ |
+
+admin_state_up
+ |
+Boolean
+ |
+Yes
+ |
+Specifies the administrative status. The value can be true or false.
+ |
+
+subnet_id
+ |
+String
+ |
+No
+ |
+Specifies the subnet ID.
+ |
+
+tenant_id
+ |
+String
+ |
+Yes
+ |
+Specifies the project ID.
+ |
+
+external_v4_ip
+ |
+String
+ |
+Yes
+ |
+Specifies the IPv4 address of the VPN service external gateway.
+ |
+
+description
+ |
+String
+ |
+Yes
+ |
+Provides supplementary information about the VPN service.
+ |
+
+vpnservice
+ |
+Object
+ |
+Yes
+ |
+Specifies the VPN service object.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "vpnservice": {
+ "router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
+ "status": "ACTIVE",
+ "name": "myvpn",
+ "admin_state_up": true,
+ "subnet_id": null,
+ "project_id": "26de9cd6cae94c8cb9f79d660d628e1f",
+ "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
+ "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
+ "description": "Updated description",
+ }
+}
+
+
+
Function
This interface is used to delete a VPN service.
+
This interface cannot be used to delete a VPN service in the active-active VPN scenarios.
+
+
+
URI
DELETE /v2.0/vpn/vpnservices/{service_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+service_id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN service ID.
+ |
+
+
+
+
+
+
+
+
Example
+
DELETE v2.0/vpn/vpnservices/{service_id}
+
+
+
+
Function
This interface is used to create an IPsec policy.
+
+
URI
POST /v2.0/vpn/ipsecpolicies
+
+
Request Message
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IPsec policy name.
+ |
+
+pfs
+ |
+String
+ |
+No
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+auth_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+No
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+ipsecpolicy
+ |
+Object
+ |
+Yes
+ |
+Specifies the IPsec policy object.
+ |
+
+lifetime
+ |
+Object
+ |
+No
+ |
+Specifies the lifetime object of SA.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+transform_protocol
+ |
+String
+ |
+No
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+value
+ |
+Integer
+ |
+No
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+No
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of tenant_id can contain a maximum of 255 characters.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of transform_protocol can only be esp, ah, or ah-esp.
- The value of auth_algorithm can only be md5, sha1, sha2-256, sha2-384, or sha2-512.
- The value of encapsulation_mode can only be tunnel.
- The value of units can only be in seconds.
- The value of value can only be an integer ranging from 60 to 604,800.
- The value of encryption_algorithm can only be aes-192, aes-256, group2, group5, or group14.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+ipsecpolicy
+ |
+Object
+ |
+Specifies the IPsec policy object.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec policy name.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+transform_protocol
+ |
+String
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
+
Example
- Request Example
POST /v2.0/vpn/ipsecpolicies
+{
+ "ipsecpolicy" : {
+ "name" : "ipsecpolicy1",
+ "transform_protocol" : "esp",
+ "auth_algorithm" : "sha1",
+ "encapsulation_mode" : "tunnel",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group5",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 7200
+ }
+ }
+}
+
+
+
- Example Response
{
+ "ipsecpolicy" : {
+ "name" : "ipsecpolicy1",
+ "transform_protocol" : "esp",
+ "auth_algorithm" : "sha1",
+ "encapsulation_mode" : "tunnel",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group5",
+ "project_id" : "ccb81365fe36411a9011e90491fe1330",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 7200
+ },
+ "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query details about an IPsec policy.
+
+
URI
GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ipsecpolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec policy ID.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The ipsecpolicy_id parameter must be specified.
+
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Specifies the IPsec policy name.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+transform_protocol
+ |
+String
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+ipsecpolicy
+ |
+Object
+ |
+Specifies the IPsec policy object.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ipsecpolicy" : {
+ "name" : "ipsecpolicy1",
+ "transform_protocol" : "esp",
+ "auth_algorithm" : "sha1",
+ "encapsulation_mode" : "tunnel",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group14",
+ "project_id" : "ccb81365fe36411a9011e90491fe1330",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 3600
+ },
+ "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query IPsec policies.
+
+
URI
GET /v2.0/vpn/ipsecpolicies
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+fields
+ |
+String
+ |
+No
+ |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.
+ |
+
+
+
+
+
The project_id parameter is not supported.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+transform_protocol
+ |
+String
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec policy name.
+ |
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+ipsecpolicies
+ |
+List<Object>
+ |
+Specifies the IPsec policy list.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ipsecpolicies" : [ {
+ "name" : "ipsecpolicy1",
+ "transform_protocol" : "esp",
+ "auth_algorithm" : "sha1",
+ "encapsulation_mode" : "tunnel",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group14",
+ "project_id" : "ccb81365fe36411a9011e90491fe1330",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 3600
+ },
+ "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c",
+ "description" : ""
+ } ]
+}
+
+
+
Function
This interface is used to update an IPsec policy.
+
If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.
+
+
+
URI
PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ipsecpolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec policy ID.
+ |
+
+
+
+
+
+
Request Message
Table 2 describes the request parameters.
+
+
Table 2 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ipsecpolicy
+ |
+Object
+ |
+Yes
+ |
+Specifies the IPsec policy object.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+transform_protocol
+ |
+String
+ |
+No
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+auth_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+No
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+pfs
+ |
+String
+ |
+No
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+value
+ |
+Integer
+ |
+No
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+No
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+lifetime
+ |
+Object
+ |
+No
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IPsec policy name.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of transform_protocol can only be esp, ah, or ah-esp.
- The value of auth_algorithm can only be md5, sha1, sha2-256, sha2-384, or sha2-512.
- The value of encapsulation_mode can only be tunnel.
- The value of units can only be in seconds.
- The value of value can only be an integer ranging from 60 to 604,800.
- The value of encryption_algorithm can only be aes-192, aes-256, group2, group5, or group14.
+
+
+
Response Message
Table 3 describes the response parameters.
+
+
Table 3 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+The value disable indicates that the PFS function is disabled.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+Specifies the IPsec policy name.
+ |
+
+transform_protocol
+ |
+String
+ |
+Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+id
+ |
+String
+ |
+Specifies the IPsec policy ID.
+ |
+
+encapsulation_mode
+ |
+String
+ |
+Specifies the encapsulation mode. The default value is tunnel.
+ |
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IPsec policy.
+ |
+
+ipsecpolicy
+ |
+Object
+ |
+Specifies the IPsec policy object.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
+
Example
+
PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+{
+ "ipsecpolicy" : {
+ "pfs" : "group14"
+ }
+}
+
+
- Example Response
{
+ "ipsecpolicy": {
+ "name": "ipsecpolicy1",
+ "transform_protocol": "esp",
+ "auth_algorithm": "sha1",
+ "encapsulation_mode": "tunnel",
+ "encryption_algorithm": "aes-128",
+ "pfs": "group14",
+ "project_id": "ccb81365fe36411a9011e90491fe1330",
+ "tenant_id": "ccb81365fe36411a9011e90491fe1330",
+ "lifetime": {
+ "units": "seconds",
+ "value": 3600
+ },
+ "id": "5291b189-fd84-46e5-84bd-78f40c05d69c",
+ "description": ""
+ }
+}
+
+
+
Function
This interface is used to delete an IPsec policy.
+
+
URI
DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ipsecpolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IPsec policy ID.
+ |
+
+
+
+
+
+
+
+
Example
+
DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+
+
+
+
Function
This interface is used to create an IKE policy.
+
+
URI
POST /v2.0/vpn/ikepolicies
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IKE policy name.
+ |
+
+auth_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+ike_version
+ |
+String
+ |
+No
+ |
+Specifies the IKE version. The value can be v1 or v2. The default value is v1.
+ |
+
+lifetime
+ |
+Object
+ |
+No
+ |
+Specifies the lifetime object of SA.
+ |
+
+pfs
+ |
+String
+ |
+No
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+No
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+value
+ |
+String
+ |
+No
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+No
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+ikepolicy
+ |
+Object
+ |
+Yes
+ |
+Specifies the IKE policy object.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of tenant_id can contain a maximum of 255 characters.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of auth_algorithm can only be md5, sha1, sha2-256, sha2-384, or sha2-512.
- The value of encryption_algorithm can only be 3des, aes-128, aes-192, or aes-256.
- The value of phase1_negotiation_mode can only be main and aggressive.
- The value of units can only be in seconds.
- The value of value can only be an integer ranging from 60 to 604,800.
- The value of ike_version can only be v1 or v2.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+Specifies the IKE policy name.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+ikepolicy
+ |
+Object
+ |
+Specifies the IKE policy object.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+ike_version
+ |
+String
+ |
+Specifies the IKE version. The value can be v1 or v2. The default value is v1.
+ |
+
+
+
+
+
+
Example
- Example Request
POST /v2.0/vpn/ikepolicies
+{
+ "ikepolicy" : {
+ "phase1_negotiation_mode" : "main",
+ "auth_algorithm" : "sha1",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group5",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 7200
+ },
+ "ike_version" : "v1",
+ "name" : "ikepolicy1"
+ }
+}
+
+
+
- Example Response
{
+ "ikepolicy" : {
+ "name" : "ikepolicy1",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "auth_algorithm" : "sha1",
+ "encryption_algorithm" : "aes-128",
+ "pfs" : "group5",
+ "phase1_negotiation_mode" : "main",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 7200
+ },
+ "ike_version" : "v1",
+ "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query details about an IKE policy.
+
+
URI
GET /v2.0/vpn/ikepolicies/{ikepolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ikepolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IKE policy ID.
+ |
+
+
+
+
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+ikepolicy
+ |
+Object
+ |
+Specifies the IKE policy object.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+name
+ |
+String
+ |
+Specifies the IKE policy name.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+ike_version
+ |
+String
+ |
+Specifies the IKE version number. The value can be v1 or v2. The default value is v1.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ikepolicy" : {
+ "name" : "ikepolicy1",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "auth_algorithm" : "sha1",
+ "encryption_algorithm" : "aes-256",
+ "pfs" : "group5",
+ "phase1_negotiation_mode" : "main",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 3600
+ },
+ "ike_version" : "v1",
+ "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to query IKE policies.
+
+
URI
GET /v2.0/vpn/ikepolicies
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+fields
+ |
+String
+ |
+No
+ |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.
+ |
+
+
+
+
+
The project_id parameter is not supported.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+ikepolicies
+ |
+List<Object>
+ |
+Specifies the IKE policy list.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+name
+ |
+String
+ |
+Specifies the IKE policy name.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+ike_version
+ |
+String
+ |
+Specifies the IKE version. The value can be v1 or v2. The default value is v1.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ikepolicies" : [ {
+ "name" : "ikepolicy1",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "auth_algorithm" : "sha1",
+ "encryption_algorithm" : "aes-256",
+ "pfs" : "group5",
+ "phase1_negotiation_mode" : "main",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 3600
+ },
+ "ike_version" : "v1",
+ "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
+ "description" : ""
+ } ]
+}
+
+
+
Function
This interface is used to update an IKE policy.
+
If the IKE policy is updated, the IPsec VPN connection also needs to be updated.
+
+
+
URI
PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ikepolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IKE policy ID.
+ |
+
+
+
+
+
+
Request Message
Table 2 describes the request parameters.
+
+
Table 2 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+auth_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+No
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+ike_version
+ |
+String
+ |
+No
+ |
+Specifies the IKE version. The value can be v1 or v2. The default value is v1.
+ |
+
+ikepolicy
+ |
+Object
+ |
+Yes
+ |
+Specifies the IKE policy object.
+ |
+
+lifetime
+ |
+Object
+ |
+No
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the IKE policy name.
+ |
+
+pfs
+ |
+String
+ |
+No
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+No
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+value
+ |
+Integer
+ |
+No
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+No
+ |
+Specifies the lifecycle unit. The default value is seconds.
+ |
+
+
+
+
+
- The ikepolicy_id parameter must be specified.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of auth_algorithm can only be md5, sha1, sha2-256, sha2-384, or sha2-512.
- The value of encryption_algorithm can only be 3des, aes-128, aes-192, or aes-256.
- The value of phase1_negotiation_mode can only be main and aggressive.
- The value of units can only be in seconds.
- The value of value can only be an integer ranging from 60 to 604,800.
- The value of ike_version can only be v1 or v2.
- The project_id parameter is not supported.
+
+
+
Response Message
Table 3 describes the response parameters.
+
+
Table 3 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+auth_algorithm
+ |
+String
+ |
+Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512.
+ |
+
+description
+ |
+String
+ |
+Provides supplementary information about the IKE policy.
+ |
+
+encryption_algorithm
+ |
+String
+ |
+Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128.
+ |
+
+id
+ |
+String
+ |
+Specifies the IKE policy ID.
+ |
+
+ike_version
+ |
+String
+ |
+Specifies the IKE version. The value can be v1 or v2. The default value is v1.
+ |
+
+lifetime
+ |
+Object
+ |
+Specifies the lifetime object of SA.
+ |
+
+name
+ |
+String
+ |
+Specifies the IKE policy name.
+ |
+
+pfs
+ |
+String
+ |
+Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable.
+The default value is group5.
+ |
+
+phase1_negotiation_mode
+ |
+String
+ |
+Specifies the IKE mode The default value is main.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+ikepolicy
+ |
+Object
+ |
+Specifies the IKE policy object.
+ |
+
+value
+ |
+Integer
+ |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+units
+ |
+String
+ |
+Specifies the lifetime unit of the SA. The default unit is seconds. The default value is 3600.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "ikepolicy" : {
+ "name" : "ikepolicy1",
+ "tenant_id" : "ccb81365fe36411a9011e90491fe1330",
+ "auth_algorithm" : "sha1",
+ "encryption_algorithm" : "aes-256",
+ "pfs" : "group5",
+ "phase1_negotiation_mode" : "main",
+ "lifetime" : {
+ "units" : "seconds",
+ "value" : 3600
+ },
+ "ike_version" : "v1",
+ "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db",
+ "description" : ""
+ }
+}
+
+
+
Function
This interface is used to delete an IKE policy.
+
+
URI
DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+ikepolicy_id
+ |
+String
+ |
+Yes
+ |
+Specifies the IKE policy ID.
+ |
+
+
+
+
+
+
+
+
+
+
+
Function
This interface is used to create a VPN endpoint group.
+
+
URI
POST /v2.0/vpn/endpoint-groups
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+endpoints
+ |
+List<String>
+ |
+Yes
+ |
+Specifies the endpoint list. The endpoints in a list must be of the same type.
+ |
+
+type
+ |
+String
+ |
+Yes
+ |
+Specifies the endpoint type. The value can be subnet or cidr.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN endpoint group name.
+ |
+
+tenant_id
+ |
+String
+ |
+No
+ |
+Specifies the project ID.
+ |
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+
+
+
+
- The project_id parameter is not supported.
- The value of tenant_id can contain a maximum of 255 characters.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The value of type can only be subnet or cidr.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+tenant_id
+ |
+String
+ |
+Yes
+ |
+Specifies the project ID.
+ |
+
+endpoints
+ |
+List<String>
+ |
+Yes
+ |
+Specifies the endpoint list. The endpoints in a list must be of the same type.
+ |
+
+type
+ |
+String
+ |
+Yes
+ |
+Specifies the endpoint type. The value can be subnet or cidr.
+ |
+
+id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN endpoint group name.
+ |
+
+
+
+
+
+
Example
- Example Request
POST /v2.0/vpn/endpoint-groups
+{
+ "endpoint_group" : {
+ "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
+ "type" : "cidr",
+ "name" : "peers"
+ }
+}
+
+
+
- Example Response
{
+ "endpoint_group" : {
+ "description" : "",
+ "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
+ "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
+ "type" : "cidr",
+ "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
+ "name" : "peers"
+ }
+}
+
+
+
Function
This interface is used to query details about a VPN endpoint group.
+
+
URI
GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+endpoint_group_id
+ |
+String
+ |
+No
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+
+
+
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+Object
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+endpoints
+ |
+List
+ |
+Specifies the endpoint list. The endpoints in a list must be of the same type.
+ |
+
+type
+ |
+String
+ |
+Specifies the endpoint type. The value can be subnet or cidr.
+ |
+
+id
+ |
+String
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+name
+ |
+String
+ |
+Specifies the VPN endpoint group name.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "endpoint_group": {
+ "description": "",
+ "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
+ "endpoints": [
+ "10.2.0.0/24",
+ "10.3.0.0/24"
+ ],
+ "type": "cidr",
+ "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
+ "name": "peers"
+ }
+}
+
+
+
Function
This interface is used to query VPN endpoint groups.
+
+
URI
GET /v2.0/vpn/endpoint-groups
+
+
Request Message
Table 1 describes the request parameters.
+
+
Table 1 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+fields
+ |
+String
+ |
+No
+ |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.
+ |
+
+
+
+
+
The project_id parameter is not supported.
+
+
+
Response Message
Table 2 describes the response parameters.
+
+
Table 2 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+String
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+tenant_id
+ |
+String
+ |
+Specifies the project ID.
+ |
+
+endpoints
+ |
+List
+ |
+Specifies the endpoint list. The endpoints in a list must be of the same type.
+ |
+
+type
+ |
+String
+ |
+Specifies the endpoint type. The value can be subnet or cidr.
+ |
+
+id
+ |
+String
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+name
+ |
+String
+ |
+Specifies the VPN endpoint group name.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "endpoint_groups": [
+ {
+ "description": "",
+ "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
+ "endpoints": [
+ "a3da778c-adfb-46db-88b3-d2ce53290a89"
+ ],
+ "type": "subnet",
+ "id": "6bf34c7c-864c-4948-a6d4-db791669f9d4",
+ "name": "locals"
+ },
+ {
+ "description": "",
+ "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
+ "endpoints": [
+ "10.2.0.0/24",
+ "10.3.0.0/24"
+ ],
+ "type": "cidr",
+ "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
+ "name": "peers"
+ }
+ ]
+}
+
+
+
Function
This interface is used to update a VPN endpoint group.
+
+
URI
PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+endpoint_group_id
+ |
+String
+ |
+No
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+
+
+
+
+
Request Message
Table 2 describes the request parameters.
+
+
Table 2 Request parametersParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+description
+ |
+String
+ |
+No
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+name
+ |
+String
+ |
+No
+ |
+Specifies the VPN endpoint group name.
+ |
+
+
+
+
+
- The endpoint_group_id parameter must be specified.
- The value of name can contain 1 to 64 characters.
- The value of description can contain a maximum of 255 characters.
- The project_id parameter is not supported.
+
+
+
Response Message
Table 3 describes the response parameters.
+
+
Table 3 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+description
+ |
+Yes
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+tenant_id
+ |
+Yes
+ |
+Specifies the project ID.
+ |
+
+endpoints
+ |
+Yes
+ |
+Specifies the endpoint list. The endpoints in a list must be of the same type.
+ |
+
+type
+ |
+Yes
+ |
+Specifies the endpoint type. The value can be subnet or cidr.
+ |
+
+id
+ |
+Yes
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+name
+ |
+Yes
+ |
+Provides supplementary information about the VPN endpoint group.
+ |
+
+
+
+
+
+
+
- Example Response
{
+ "endpoint_group" : {
+ "description" : "New description",
+ "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
+ "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
+ "type" : "cidr",
+ "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
+ "name" : "peers"
+ }
+}
+
+
+
Function
This interface is used to delete a VPN endpoint group.
+
+
URI
DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+
+
Table 1 Parameter descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+endpoint_group_id
+ |
+String
+ |
+Yes
+ |
+Specifies the VPN endpoint group ID.
+ |
+
+
+
+
+
+
+
+
Example
+
DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+
+
+
+