
# 查询用户登录记录 - ListUserConnection
#### 功能介绍
查询用户登录记录。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListUserConnection)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                  | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:session:listUserConnection | Write | -           | -   | -  | -      |
     
  
 
#### URI
POST /v1/{project_id}/session/user-connection
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                      |
|:---|:---|:---|:---|
| limit  | 否    | Integer | 单次查询的大小\[1-100\]，默认值10。 |
| offset | 否    | Integer | 查询的偏移量，默认值0。            |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                              |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表4请求Body参数 
| 参数               | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| id               | 否    | String | 登录记录唯一标识ID。                                                                                                                                                                                                                                                                                                                                                                         |
| connect_type     | 否    | String | 用户连接类别,1代表共享桌面，2代表普通应用。                                                                                                                                                                                                                                                                                                                                                             |
| user_name        | 否    | String | 登录用户名称。                                                                                                                                                                                                                                                                                                                                                                             |
| machine_sid      | 否    | String | 应用服务器sid。                                                                                                                                                                                                                                                                                                                                                                           |
| machine_name     | 否    | String | 应用服务器名称。                                                                                                                                                                                                                                                                                                                                                                            |
| failed_reason    | 否    | String | 连接失败原因。                                                                                                                                                                                                                                                                                                                                                                             |
| failed_code      | 否    | String | 连接失败状态码。                                                                                                                                                                                                                                                                                                                                                                            |
| client_name      | 否    | String | 客户端名称。                                                                                                                                                                                                                                                                                                                                                                              |
| client_version   | 否    | String | 客户端版本。                                                                                                                                                                                                                                                                                                                                                                              |
| client_type      | 否    | String | 客户端操作系统类型： - Mac   - Windows    |
| agent_version    | 否    | String | aps hda版本。                                                                                                                                                                                                                                                                                                                                                                          |
| vm_ip            | 否    | String | 应用服务器ip。                                                                                                                                                                                                                                                                                                                                                                            |
| connect_flag     | 否    | String | 连接标志，目前值为0。                                                                                                                                                                                                                                                                                                                                                                         |
| wi_ip            | 否    | String | 连接IP。                                                                                                                                                                                                                                                                                                                                                                               |
| public_ip        | 否    | String | 客户端出口ip。                                                                                                                                                                                                                                                                                                                                                                            |
| update_time      | 否    | String | 登录应用开始时间，只支持导出30天内数据，格式 2022-10-31T08:07:39Z。                                                                                                                                                                                                                                                                                                                                       |
| tenant_id        | 否    | String | 租户id。                                                                                                                                                                                                                                                                                                                                                                               |
| login_start_time | 否    | String | 登录应用开始时间，只支持导出30天内数据，格式 2022-10-31T08:07:39Z，参数中login_start_time与login_end_time必须同时存在或都不存在，都不存在时导出近一个月的数据。                                                                                                                                                                                                                                                                          |
| login_end_time   | 否    | String | 登录应用结束时间，只支持导出30天内数据，格式 2022-10-31T08:07:39Z，参数中login_start_time与login_end_time必须同时存在或都不存在，都不存在时导出近一个月的数据。                                                                                                                                                                                                                                                                          |
| virtual_ip       | 否    | String | 会话虚拟ip。                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 响应参数
**状态码：200**
表5响应Body参数 
| 参数    | 参数类型                                                                                    | 描述        |
|:---|:---|:---|
| count | Integer                                                                                 | 总数。       |
| items | Array of [UserConnectionInfo] objects | 应用使用记录列表。 |
   
 表6UserConnectionInfo 
| 参数                 | 参数类型   | 描述         |
|:---|:---|:---|
| id                 | String | 主键。        |
| connect_type       | String | 连接类型。      |
| user_name          | String | 登录用户。      |
| desktop_group_name | String | 桌面组名。      |
| pre_conn_time      | String | 预连接时间。     |
| start_time         | String | 开始时间。      |
| end_time           | String | 结束时间。      |
| machine_sid        | String | 应用服务器sid。  |
| machine_name       | String | 应用服务器名称。   |
| failed_reason      | String | 连接失败原因。    |
| failed_code        | String | 连接失败状态码。   |
| client_mac         | String | 客户端Mac。    |
| client_name        | String | 客户端名称。     |
| client_ip          | String | 客户端ip。     |
| client_version     | String | 客户端版本。     |
| client_type        | String | 客户端操作系统类型。 |
| agent_version      | String | aps hda版本。 |
| vm_ip              | String | 应用服务器ip。   |
| connect_flag       | String | 连接标志。      |
| wi_ip              | String | 连接IP。      |
| update_time        | String | 更新时间。      |
| tenant_id          | String | 租户id。      |
| virtual_ip         | String | 会话虚拟ip。    |
| public_ip          | String | 客户端出口ip。   |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：401**
表8响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：403**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：404**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：405**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：415**
表12响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：500**
表13响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：503**
表14响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
#### 请求示例
```
POST /v1/a4da8115c9d8464ead3a38309130523f/session/user-connection?limit=10&offset=0
{
  "login_start_time" : "2025-04-24T16:00:00Z",
  "login_end_time" : "2025-05-24T10:21:49Z"
}
```
#### 响应示例
**状态码：200**
成功响应。
```
{
  "count" : 2,
  "items" : [ {
    "id" : "394",
    "connect_type" : "2",
    "user_name" : "user001@wksapp***.huawei.com",
    "pre_conn_time" : "2023-06-05T03:34:43Z",
    "start_time" : "2023-06-05T06:37:47Z",
    "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418",
    "machine_name" : "APS-XS1QJ3TA7T",
    "failed_reason" : "",
    "failed_code" : "",
    "client_mac" : "c8-d9-d2-**-3a-57",
    "client_name" : "Y002516E2p1",
    "client_ip" : "10.*73.108.206",
    "client_version" : "23.2.2.0",
    "client_type" : "Windows 10",
    "agent_version" : "23.2.2.0423",
    "vm_ip" : "10.*.248.130",
    "connect_flag" : "0",
    "wi_ip" : "192.**.10.*00\\#192.**.10.23",
    "update_time" : "2023-06-05T06:37:47Z",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "virtual_ip" : ""
  }, {
    "id" : "112",
    "connect_type" : "2",
    "user_name" : "nas01@wksapp***.huawei.com",
    "pre_conn_time" : "2023-05-23T09:10:03Z",
    "start_time" : "2023-05-23T09:10:04Z",
    "end_time" : "2023-05-23T09:16:15Z",
    "machine_sid" : "S-1-5-21-1213649063-4191095369-2401105760-1395",
    "machine_name" : "APS-Z5OV9E157G",
    "failed_reason" : "",
    "failed_code" : "",
    "client_mac" : "68-05-ca-**-c7-98",
    "client_name" : "kdjhfkjhdghschd",
    "client_ip" : "10.**.**.151",
    "client_version" : "23.5.0.0",
    "client_type" : "Windows 10",
    "agent_version" : "23.5.0.0519",
    "vm_ip" : "10.*.83.5",
    "connect_flag" : "0",
    "wi_ip" : "192.**.10.*00\\#192.**.10.23",
    "update_time" : "2023-05-23T09:16:15Z",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "virtual_ip" : ""
  } ]
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 成功响应。                   |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 415 | 请求中提交的资源格式不支持。          |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。
