Query SSL-VPN user
Updated at:2025-10-16
Description
Query the list of SSL-VPN users.
Request structure
Plain Text
1GET /v{version}/vpn/{vpnId}/sslVpnUser?marker={marker}&maxKeys={maxKeys}&userName={userName} 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 | Required or not | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| vpnId | String | Yes | URL parameter | SSL-VPN ID |
| marker | String | No | Query | Starting position of batch list query, which is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
| userName | String | No | Query | SSL-VPN user name |
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 | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | Integer | Maximum number of items included per page |
| sslVpnUsers | List<[SslVpnUserVo](VPC/API Reference/Appendix.md#SslVpnUserVo)> | List of SSL-VPN users |
Request example
Plain Text
1GET /v1/vpn/vpn-119bd69b/sslVpnUser?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 "marker": "vpn-ssl-user-xynkefqf3n5x",
8 "maxKeys": 1,
9 "isTruncated": false,
10 "sslVpnUsers": [
11 {
12 "userId": "vpn-ssl-user-xynkefqf3n5x",
13 "userName": "user",
14 "description": "desc"
15 }
16 ]
17}
