• Native OpenStack API

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

List VPN services

Function Description

This interface is used to query the list of VPN services.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/vpnservices

Queries the list of VPN services.

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

vpnservices

List<Object>

Yes

Specifies a VPN service object.

status

String

Yes

Specifies whether the IPSec VPN service is currently operational. A valid value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

router_id

String

Yes

Specifies the ID of the router.

name

String

Yes

Specifies the name of the VPN service.

external_v6_ip

String

Yes

Specifies the external gateway IPv6 address that is used for the VPN service.

admin_state_up

Boolean

Yes

Specifies the administrator status. The value can be true or false.

subnet_id

String

No

Specifies the ID of the subnet.

tenant_id

String

Yes

Specifies the ID of the tenant.

external_v4_ip

String

Yes

Specifies the external gateway IPv4 address that is used for the VPN service.

id

String

No

Specifies the ID of the VPN service.

description

String

Yes

Specifies the description about the VPN service.

project_id

String

Yes

Specifies the ID of the project.

Request Example

None

Response Example

{
 "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" : ""
 } ]
}

Error Code

For details, see section Return Code Processing.