文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 终端入云VPN API/ 访问策略/ 查询VPN访问策略列表
更新时间：2024-08-23 GMT+08:00
查看PDF
分享

查询VPN访问策略列表

功能介绍

通过VPN服务端ID,查询VPN访问策略列表。

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies

表1 参数说明

名称

类型

是否必选

描述

project_id

String

是

项目ID，可以通过获取项目ID获取项目ID。

vpn_server_id

String

是

VPN服务端ID
表2 请求Query参数列表

名称

类型

是否必选

描述

limit

Integer

否

分页查询时每页返回的记录数量

marker

String

否

上一页最后一条记录的id,为空时为查询第一页。必须与limit一起使用。

请求消息

  • 请求参数

    无。

  • 请求样例 
    GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/access-policies

响应消息

  • 响应参数

    返回状态码为 200: 查询成功。

表3 响应Body参数列表

名称

类型

描述

access_policies

Array of VpnAccessPolicy objects

访问策略对象列表

total_count

Integer

总数

page_info

PageInfo object

分页查询页的信息

request_id

String

请求ID
表4 VpnAccessPolicy

名称

类型

描述

id

String
  • 功能描述：访问策略ID
  • 格式：36位UUID

name

String

访问策略名称

user_group_id

String
  • 功能描述：关联用户组ID
  • 格式：36位UUID

user_group_name

String

关联用户组名称

description

String

访问策略描述

dest_ip_cidrs

Array of String
  • 功能描述：目的IP网段列表
  • 格式："点分十进制/掩码"格式，例如192.168.1.0/24

created_at

String
  • 功能说明：创建时间
  • UTC时间格式：yyyy-MM-ddTHH:mm:ssZ

updated_at

String
  • 功能说明：更新时间
  • UTC时间格式：yyyy-MM-ddTHH:mm:ssZ
表5 PageInfo

名称

类型

描述

next_marker

String

下一页的marker,值为上一次查询响应中最后一个资源的创建时间

current_count

Integer

当前列表中资源数量
  • 响应样例 
    {
    "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": "访问策略1",
            "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"
}

状态码

请参见状态码。

父主题： 访问策略