Querying the VPN User List
Function
This API is used to query the user list based on a specified VPN server ID.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. |
vpn_server_id |
Yes |
Specifies the ID of a VPN server. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
limit |
Integer |
No |
Specifies the number of records returned on each page during pagination query. |
marker |
String |
No |
|
Request
Response
- Response parameters
Returned status code 200: successful query
Table 3 Parameters in the response body Parameter
Type
Description
users
Array of VpnUser objects
Specifies user list information.
total_count
Integer
Specifies the total number of users on the current VPN server.
page_info
PageInfo object
Specifies pagination query information.
request_id
String
Specifies a request ID.
Table 4 VpnUser Parameter
Type
Description
id
String
- Specifies a user ID.
- The value is a UUID containing 36 characters.
name
String
Specifies a username.
description
String
Specifies user description.
user_group_id
String
- Specifies the ID of the user group to which the user belongs.
- The value is a UUID containing 36 characters.
user_group_name
String
Specifies the name of the user group to which the user belongs.
static_ip
String
- Specifies the static IP address of a client.
- The value is an IPv4 address in dotted decimal notation (for example, 192.168.0.5) or disable.
created_at
String
- Specifies the creation time.
- The UTC time format is yyyy-MM-ddTHH:mm:ssZ.
updated_at
String
- Specifies the update time.
- The UTC time format is yyyy-MM-ddTHH:mm:ssZ.
- Example response
{ "users": [ { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d", "name": "user001", "description": "UserDescription1", "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W", "user_group_name": "user-group1", "created_at": "2024-06-17T06:53:46.302Z", "updated_at": "2024-06-17T06:53:46.302Z" }, { "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d", "name": "user002", "description": "UserDescription2", "user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W", "user_group_name": "user-group1", "created_at": "2024-06-17T06:53:46.302Z", "updated_at": "2024-06-17T06:53:46.302Z" } ], "total_count": 2, "page_info": { "current_count": 2 }, "request_id": "b04b68fb4d548344e0bc4b34dbd6f6e7" }
Status Codes
For details, see Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.