Query SSL-VPN server
Updated at：2025-10-16
Description
Query the SSL-VPN server.
Request structure
Plain Text
1GET /v{version}/vpn/{vpnId}/sslVpnServer?clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| clientToken | String | No | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits, for details, refer to ClientToken Idempotence. |
| 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 |
| sslVpnServerId | String | SSL-VPN server ID |
| sslVpnServerName | String | SSL-VPN server name |
| interfaceType | String | SSL-VPN server API type |
| status | String | SSL-VPN server status |
| localSubnets | List<String> | List of local network CIDRs |
| remoteSubnet | String | Client network CIDRs |
| clientDns | String | Client DNS address |
| maxConnection | Integer | Maximum count of client connections for SSL-VPN |
Request example
Plain Text
1GET /v1/vpn/vpn-119bd69b/sslVpnServer?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2021 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6 {
7 "vpnId": "vpn-shyt1vzgqc3z",
8 "sslVpnServerId": "sslvpn-5b2hq4nm40tt",
9 "sslVpnServerName": "hzb_1_1",
10 "interfaceType": "tap",
11 "status": "active",
12 "localSubnets": ["192.168.0.0/24"],
13 "remoteSubnet": "172.168.0.0/16",
14 "maxConnection": 10,
15 "clientDns":""
16 }