• Native OpenStack API

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

Show VPN service

Function Description

This interface is used to query details of a VPN service.

Interface Format

Method

URI

Description

GET

/v2.0/vpn/vpnservices/{service_id}

Queries details of a VPN service.

Restrictions

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

Request Parameter

Parameter

Type

Mandatory

Description

service_id

String

No

Specifies the ID of the VPN service.

Response Parameter

Parameter

Type

Mandatory

Description

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

Yes

Specifies the ID of the VPN service.

description

String

Yes

Specifies the description about the VPN service.

vpnservice

Object

Yes

Specifies a VPN service object.

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.