查询组内VPN用户

功能介绍

根据VPN用户组ID,查询组内用户信息。

调用方法

URI

GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/users

表1 参数说明
名称	类型	是否必选	描述
project_id	String	是	项目ID，可以通过获取项目ID获取项目ID。
vpn_server_id	String	是	VPN服务端ID。
group_id	String	是	用户组ID。

表2 请求Query参数列表
名称	类型	是否必选	描述
limit	Integer	否	分页查询时每页返回的记录数量。
marker	String	否	功能说明：查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。约束：必须与limit一起使用。

请求消息

请求参数
 无。

请求样例

GET https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/groups/{group_id}/users

响应消息

响应参数

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

表3 响应Body参数列表
名称	类型	描述
users	Array of VpnUserInGroup objects	用户组对象列表。
total_count	integer	用户总数。
page_info	PageInfo object	分页查询页的信息。
request_id	String	请求ID。

表4 VpnUserInGroup
名称	类型	描述
id	String	功能说明：用户ID。功能说明：36位UUID。
name	String	用户名称。
description	String	用户描述。

表5 PageInfo
名称	类型	描述
next_marker	String	下一页的marker,值为上一次查询响应中最后一个资源的创建时间。
current_count	Integer	当前列表中资源数量。

响应样例

{
    "users": [
        {
            "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
            "name": "user1",
            "description": "用户1描述"
        }
    ],
    "total_count": 1,
    "page_info": {
        "current_count": 1
    },
    "request_id": "146c67110e52963d5bf62785aede7308"
}