# 查询VPN用户列表 - QueryVPNUsers
#### 功能介绍
根据VPN服务端ID,查询用户信息列表。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpn/vpn_api_0044.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项                 | 访问级别 | 资源类型（\*为必须）   | 条件键                       | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| vpn:p2cVpnUser:list | list | p2cVpnUser    | -                         | -  | -      |
| vpn:p2cVpnUser:list | list | p2cVpnGateway | g:ResourceTag/\<tag-key\> | -  | -      |
   
#### URI
GET /v5/{project_id}/p2c-vpn-gateways/vpn-servers/{vpn_server_id}/users
表1参数说明 
| 名称            | 是否必选 | 描述                                                                                  |
|:---|:---|:---|
| project_id    | 是    | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 |
| vpn_server_id | 是    | VPN服务端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}/users
  ```
  
 
#### 响应消息
- 响应参数 返回状态码为 200: 查询成功。
  表3响应Body参数列表 
  | 名称          | 类型                                                                             | 描述              |
  |:---|:---|:---|
  | users       | Array of [VpnUser] objects | 用户列表信息。         |
  | total_count | Integer                                                                        | 当前VPN服务端下的用户总数。 |
  | page_info   | [PageInfo] object          | 分页查询页的信息。       |
  | request_id  | String                                                                         | 请求ID。           |
     
   表4VpnUser 
  | 名称              | 类型     | 描述                                                                                                                                                                                                                                                                                                               |
  |:---|:---|:---|
  | id              | String | - 功能说明：用户ID。  - 格式：36位UUID。                                             |
  | name            | String | 用户名称。                                                                                                                                                                                                                                                                                                            |
  | description     | String | 用户描述。                                                                                                                                                                                                                                                                                                            |
  | user_group_id   | String | - 功能说明：所属用户组ID。  - 格式：36位UUID。                                                 |
  | user_group_name | String | 所属用户组名称。                                                                                                                                                                                                                                                                                                         |
  | static_ip       | String | - 功能说明：客户端的静态IP地址。  - 格式：点分十进制IPv4地址（如192.168.0.5）或者"disable"。   |
  | created_at      | String | - 功能说明：创建时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ。*                   |
  | updated_at      | String | - 功能说明：更新时间。  - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ*。                     |
     
   表5PageInfo 
  | 名称            | 类型      | 描述                                |
  |:---|:---|:---|
  | 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": {
          "current_count": 2
      },
      "request_id": "b04b68fb4d548344e0bc4b34dbd6f6e7"
  }
  ```
  
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。