Query VPN List
Updated at：2025-10-16
Description
Retrieve the VPN list details.
Request structure
Plain Text
1GET /v{version}/vpn?marker={marker}&maxKeys={maxKeys}&vpcId={vpcId}&eip={eip}&type={type} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: 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 |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
| vpcId | String | Yes | Query | Identifier of the VPC to which the VPN belongs |
| eip | String | No | Query | Address of EIP bound to the VPN |
| type | String | No | Query | VPN gateway type: "IPSec" returns IPSec-VPN gateway, "SSL |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | Boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | Obtain the marker value required for retrieving the next page; this field will not appear when isTruncated is false |
| maxKeys | Integer | Maximum number of items included per page |
| vpns | List<[Vpn](VPC/API Reference/Appendix.md#Vpn)> | List of VPNs |
Request example
Plain Text
1GET /v{version}/vpn?marker=vpn-IyWRtII7&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 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 "nextMarker": "vpn-xktdeMSf",
8 "marker": "vpn-IyWRtII7",
9 "maxKeys": 1,
10 "isTruncated": true,
11 "vpns": [
12 {
13 "status": "active",
14 "eip": "10.12.34.32",
15 "vpnId": "vpn-IyWRtII7",
16 "vpcId": "83edd0d2-8a68-4ce5-a396-9d2917d58a57",
17 "description": "",
18 "expiredTime": "2022-04-25 17:22:34",
19 "paymentTiming": "Postpaid",
20 "vpnConnNum": 0,
21 "bandwidthInMbps": 10,
22 "type": "IPSec",
23 "vpnConns": [],
24 "vpnName": "VPN_aoko_2",
25 "createTime": "2021-04-25 17:22:34"
26 }
27 ]
28}