Query VPN details
Updated at：2025-10-16
Description
Get the details of a specified VPN.
Request structure
Plain Text
1 GET /v{version}/vpn/{vpnId} HTTP/1.1
2 Host: bcc.bj.baidubce.com
3 Authorization: authorization string Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| vpnId | String | Yes | URL parameter | VPN ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| vpnId | String | VPN ID |
| vpnName | String | Name |
| createTime | String | Creation time |
| description | String | Description |
| type | String | VPN gateway type, with value "IPSec" indicating IPSec-VPN gateway and value "SSL" indicating SSL-VPN gateway |
| status | String | VPN status: active, building, and unconfigured |
| expiredTime | String | Expiration time |
| paymentTiming | String | Bill type |
| eip | String | Public IP address |
| bandwidthInMbps | Integer | EIP bandwidth |
| vpcId | String | VPC ID |
| vpnConnNum | Integer | Tunnel count |
| maxConnection | Integer | Maximum count of client connections for SSL-VPN |
| vpnConns | List<[VpnConn](VPC/API Reference/Appendix.md#VpnConn)> | List of VPN tunnels |
| sslVpnServer | [SslVpnServer](VPC/API Reference/Appendix.md#SslVpnServer) | SSL-VPN server |
| tags | List<[TagModel](VPC/API Reference/Appendix.md#TagModel)> | Tags bound to VPN instances |
| deleteProtect | Boolean | Whether to enable release protection |
Request example
Plain Text
1 GET /v1/vpn/vpn-shkgan7et1vx HTTP/1.1
2 Host: bcc.bj.baidubce.com
3 Authorization: authorization string Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content-Type: application/json;charset=UTF-8
5 Server: BWS
6 {
7 "status": "active",
8 "eip": "",
9 "vpnId": "vpn-shkgan7et1vx",
10 "vpcId": "83edd0d2-8a68-4ce5-a396-9d2917d58a57",
11 "description": "",
12 "expiredTime": "2022-04-25 17:22:34",
13 "paymentTiming": "Postpaid",
14 "vpnConnNum": 0,
15 "bandwidthInMbps": 0,
16 "vpnConns": [],
17 "vpnName": "VPN_aoko_2",
18 "createTime": "2021-04-25 17:22:34",
19 "type": "SSL",
20 "maxConnection": 20,
21 "deleteProtect": true,
22 "tags": [
23 {
24 "tagKey": "hikwnf",
25 "tagValue": "nwklwmflk"
26 },
27 {
28 "tagKey": "whfooef",
29 "tagValue": "haiwnwejf"
30 }
31 ]
32 }