• Native OpenStack API

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

Show VPN endpoint group

Function Description

This interface is used to query details about a VPN endpoint group.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/endpoint-groups/{endpoint_group_id}

Queries details about a VPN endpoint group.

Restrictions

  • Parameter endpoint_group_id is mandatory.
  • The project_id attribute is not supported.

Request Parameter

Parameter

Type

Mandatory

Description

endpoint_group_id

String

No

Specifies the ID of the VPN endpoint group.

Response Parameter

Parameter

Type

Mandatory

Description

description

Object

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

GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}

Response Example

None

Error Code

For details, see section Return Code Processing.