• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. VPNaas
  6. Create VPN endpoint group

Create VPN endpoint group

Function Description

This interface is used to create a VPN endpoint group.

Interface Format

Method

URI

Description

POST

/v2.0/vpn/endpoint-groups

Creates a VPN endpoint group.

Restrictions

  • The project_id attribute is not supported.
  • The tenant_id value is the UUID.
  • The name value must contain 1 to 64 characters.
  • The description value can contain a maximum of 255 characters.
  • The value of endpoint_type can be only subnet and cidr. The value is subnet for a local subnet and cidr for a remote subnet.

Request Parameter

Parameter

Type

Mandatory

Description

endpoints

List<String>

Yes

Specifies the list of endpoints of the same type for the endpoint group.

type

String

Yes

Specifies the type of endpoints. A valid value can be subnet or cidr.

name

String

Yes

Specifies the name of the VPN endpoint group.

tenant_id

String

Yes

Specifies the ID of the tenant.

project_id

String

Yes

Specifies the ID of the project.

description

String

Yes

Specifies the description about the VPN endpoint group.

Response Parameter

Parameter

Type

Mandatory

Description

description

String

Yes

Specifies the description about the VPN endpoint group.

tenant_id

String

Yes

Specifies the ID of the tenant.

endpoints

List<String>

Yes

Specifies the list of endpoints of the same type for the endpoint group.

type

String

Yes

Specifies the type of endpoints. A valid value can be subnet or cidr.

id

String

Yes

Specifies the ID of the VPN endpoint group.

name

String

Yes

Specifies the name of the VPN endpoint group.

project_id

String

Yes

Specifies the ID of the project.

Request Example

POST /v2.0/vpn/endpoint-groups
{
 "endpoint_group" : {
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr",
"name" : "peers"
 }
}

Response Example

{
 "endpoint_group" : {
"description" : "",
"project_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
"tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr",
"id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name" : "peers"
 }
}

Error Code

For details, see section Return Code Processing.