• Native OpenStack API

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

List VPN endpoint groups

Function Description

This interface is used to query the list of VPN endpoint groups.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/endpoint-groups

Queries the list of VPN endpoint groups.

Restrictions

The project_id attribute is not supported.

Request Parameter

Parameter

Type

Mandatory

Description

fields

String

No

Specifies the fields that you want the server to return. If no fields are specified, all attributes allowed by the policy settings are returned.

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

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

None

Response Example

None

Error Code

For details, see section Return Code Processing.