gtema 6b71b4a1fa Initial import of the VPN API document

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>

2022-12-07 13:22:09 +00:00

13 KiB

Raw Blame History

Querying Details About a VPN Service

Function

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

URI

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

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
service_id	String	Yes	Specifies the VPN service ID.

Request Message

None

Response Message

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Mandatory	Description
status	String	Yes	Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
router_id	String	Yes	Specifies the router ID.
name	String	No	Specifies the VPN service name.
external_v6_ip	String	Yes	Specifies the IPv6 address of the VPN service external gateway.
admin_state_up	Boolean	No	Specifies the administrative status. The value can be true or false.
subnet_id	String	No	Specifies the subnet ID.
tenant_id	String	No	Specifies the project ID.
external_v4_ip	String	Yes	Specifies the IPv4 address of the VPN service external gateway.
id	String	Yes	Specifies the VPN service ID.
description	String	No	Provides supplementary information about the VPN service.
vpnservice	Object	Yes	Specifies the VPN service object.

Example

Example Request
```
GET /v2.0/vpn/vpnservices/{service_id}
```

Example Response

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

Returned Values

For details, see section Common Returned Values.

Parent topic: VPN Service Management

13 KiB Raw Blame History