Querying a VPN Access Policy

Function

This API is used to query a VPN access policy 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/{policy_id}

**Table 1** Parameter description
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.
policy_id	String	Yes	Specifies the ID of an access policy.

Request

Request parameters
None

Example request

GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies/{policy_id}

Response

Response parameters

Returned status code 200: successful query

**Table 2** Parameters in the response body
Parameter	Type	Description
access_policy	VpnAccessPolicy object	Specifies the VPN access policy object.
request_id	String	Specifies a request ID.

**Table 3** VpnAccessPolicy
Parameter	Type	Description
id	String	Specifies the ID of an access policy. The value is a UUID containing 36 characters.
name	String	Specifies the name of an access policy.
user_group_id	String	Specifies the ID of the associated user group. The value is a UUID containing 36 characters.
user_group_name	String	Specifies the name of the associated user group.
description	String	Specifies access policy description.
dest_ip_cidrs	Array of String	Specifies the list of destination CIDR blocks. The value is in the format of dotted decimal notation/mask, for example, 192.168.1.0/24.
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

{
    "access_policy": {
        "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"
    },
    "request_id": "85657002f01c35576606003cc36114ab"
}