查询VPN用户列表

功能介绍

根据VPN服务端ID,查询用户信息列表。

调用方法

请参见如何调用API。

URI

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

请求消息

• 请求参数

  无。

• 请求样例

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

响应消息

• 响应参数

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

  表3 响应Body参数列表

  名称	类型	描述
  users	Array of VpnUser objects	用户列表信息
  total_count	Integer	当前VPN服务端下的用户总数
  page_info	PageInfo object	分页查询页的信息
  request_id	String	请求ID

  表4 VpnUser

  名称	类型	描述
  id	String	功能说明：用户ID 格式：36位UUID
  name	String	用户名称
  description	String	用户描述
  user_group_id	String	功能说明：所属用户组ID 格式：36位UUID
  user_group_name	String	所属用户组名称
  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	当前列表中资源数量

• 响应样例

  {
      "users": [
          {
              "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
  			"name": "user001",
  			"description": "用户描述1",
  			"user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W",
  			"user_group_name": "user-group1",
  			"created_at": "2024-06-17T06:53:46.302Z",        
  			"updated_at": "2024-06-17T06:53:46.302Z"
          },
  		{
              "id": "41ad472e-d3e4-482b-8f00-7b2c1bfc4b7d",
  			"name": "user002",
  			"description": "用户描述2",
  			"user_group_id": "yWYnJt0R-Q0a7-R4QW-tFXX-QfundEqrR27W",
  			"user_group_name": "user-group1",
  			"created_at": "2024-06-17T06:53:46.302Z",        
  			"updated_at": "2024-06-17T06:53:46.302Z"
          }
      ],
      "total_count": 2,
      "page_info": {
          "next_marker": null,
          "current_count": 2
      },
      "request_id": "b04b68fb4d548344e0bc4b34dbd6f6e7"
  }

状态码

请参见状态码。