Querying the VPN Access Policy List
Function
This API is used to query the list of VPN access policies on a VPN server with a specified ID.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. |
vpn_server_id |
String |
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
Parameter |
Type |
Description |
---|---|---|
access_policies |
Array of VpnAccessPolicy objects |
Specifies the access policy list object. |
total_count |
Integer |
Specifies the total number of access policies. |
page_info |
PageInfo object |
Specifies pagination query information. |
request_id |
String |
Specifies a request ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
name |
String |
Specifies the name of an access policy. |
user_group_id |
String |
|
user_group_name |
String |
Specifies the name of the associated user group. |
description |
String |
Specifies access policy description. |
dest_ip_cidrs |
Array of String |
|
created_at |
String |
|
updated_at |
String |
|
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Specifies the marker of the next page. The value is the time when the last resource in the last query response was created. |
current_count |
Integer |
Specifies the number of resources in the list. |
- Example response
{ "access_policies": [ { "id": "4f746482-a575-4e1f-9e80-5f6f69ff8588", "name": "policy-001", "user_group_id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8", "user_group_name": "user-group1", "description": "AccessPolicy1", "dest_ip_cidrs": [ "172.16.0.0/24", "172.16.1.0/24" ], "created_at": "2024-06-17T13:32:19.57Z", "updated_at": "2024-06-17T13:32:19.57Z" } ], "total_count": 1, "page_info": { "next_marker": null, "current_count": 1 }, "request_id": "02b5b35cab4c2963d1d89560f50017b9" }
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot