查询VPN用户组列表

功能介绍

查询指定服务端下，用户组信息列表。

调用方法

请参见如何调用API。

URI

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

请求消息

• 请求参数

  无。

• 请求样例

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

响应消息

• 响应参数

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

  表3 响应Body参数列表

  名称	类型	描述
  user_groups	Array of VpnUserGroup objects	用户组对象列表。
  total_count	Integer	用户组总数。
  page_info	PageInfo object	分页查询页的信息。
  request_id	String	请求ID。

  表4 VpnUserGroup

  名称	类型	描述
  id	String	功能描述：VPN用户组ID。 格式：36位UUID。
  name	String	用户组名称。
  description	String	用户组描述。
  type	String	功能说明：用户组类型。 取值范围： Default：默认用户组。 Custom：用户创建用户组。
  user_number	Integer	用户数量。
  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	当前列表中资源数量。

  • 响应样例

    {
        "user_groups": [
            {
                "id": "7625fd92-2e20-4e4d-8c56-66f110fbfaa8",
                "name": "user-group1",
                "description": "用户组1",
                "type": "Custom",
                "user_number": 0,
                "created_at": "2024-06-17T09:48:27.548Z",
                "updated_at": "2024-06-17T09:48:27.548Z"
            },
            {
                "id": "0748b24e-cbd3-474e-9546-8586e8f2b5c6",
                "name": "default",
                "description": "Default user group",
                "type": "Default",
                "user_number": 0,
                "created_at": "2024-06-17T03:45:25.879Z",
                "updated_at": "2024-06-17T03:45:25.879Z"
            }
        ],
        "total_count": 2,
        "page_info": {
            "next_marker": null,
            "current_count": 2
        },
        "request_id": "1ae5c7648497d3d90824985367da954a"
    }

状态码

请参见状态码。