
# 查询用户事件 - ListUserEvents
#### 功能介绍
查询用户事件，一次最多查询30天，支持最近30天的数据查询。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListUserEvents)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                       | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:userEvents:list | List | -           | -   | -  | -      |
     
  
 
#### URI
GET /v2/{project_id}/user-events
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数            | 是否必选 | 参数类型    | 描述                                         |
|:---|:---|:---|:---|
| start_time    | 是    | String  | 查询起始时间，格式为：UTC时间，例如"1970-01-01T00:00:00Z"。 |
| end_time      | 是    | String  | 查询结束时间，格式为：UTC时间，例如"1970-01-01T00:00:00Z"。 |
| username      | 否    | String  | 用户名（精确搜索）。                                 |
| event_type    | 否    | String  | 事件类型，英文逗号隔开。                               |
| resource_id   | 否    | String  | 操作资源ID。                                    |
| resource_name | 否    | String  | 操作资源名称。                                    |
| domain        | 否    | String  | 域名                                         |
| offset        | 否    | Integer | 用于分页查询，查询的起始记录序号，从0开始。                     |
| limit         | 否    | Integer | 用于分页查询，返回用户事件数量限制，取值范围0-1000。如果不指定，默认为100。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数    | 参数类型                                                                    | 描述      |
|:---|:---|:---|
| count | Integer                                                                 | 事件总数。   |
| items | Array of [UserEventRsp] objects | 用户事件列表。 |
   
 表4UserEventRsp 
| 参数             | 参数类型    | 描述                                       |
|:---|:---|:---|
| project_id     | String  | 项目id。                                    |
| username       | String  | 用户名。                                     |
| workspace_id   | String  | 企业id。                                    |
| event_trace_id | String  | 事件之间的关联id。                               |
| event_type     | String  | 事件类型。                                    |
| event_time     | String  | 事件时间，格式为：UTC时间，例如"1970-01-01T00:00:00Z"。 |
| resource_type  | String  | 操作对象类型。                                  |
| resource_id    | String  | 操作对象id。                                  |
| resource_name  | String  | 操作对象名称。                                  |
| client_type    | String  | 客户端类型。                                   |
| client_ip      | String  | 客户端ip。                                   |
| client_mac     | String  | 客户端mac地址。                                |
| client_version | String  | 客户端版本。                                   |
| source_ip      | String  | 操作用户源ip。                                 |
| is_success     | Boolean | 是否成功。                                    |
| error_code     | String  | 错误码。                                     |
| error_msg      | String  | 错误描述。                                    |
| action_type    | String  | 触发事件的类型，USER-用户触发，SYSTEM-系统触发。           |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
**状态码：401**
表6响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
**状态码：500**
表7响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误描述。 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
响应成功。
```
{
  "count" : 0,
  "items" : [ {
    "project_id" : "xxx",
    "username" : "xxx",
    "workspace_id" : "xxx",
    "event_trace_id" : "407481bd-65b4-4de4-a553-67d858cbe29b",
    "event_type" : "loginByPassword",
    "event_time" : "1970-01-01T00:00:00Z",
    "resource_type" : "USER",
    "resource_id" : "407481bd-65b4-4de4-a553-67d858cbe29b",
    "resource_name" : "DESKTOP-01",
    "client_type" : "WINDOWS",
    "client_ip" : "127.0.0.1",
    "client_mac" : "xx.xx.xx.xx",
    "source_ip" : "127.0.0.1",
    "is_success" : true,
    "error_code" : "WKS.00000000",
    "error_msg" : "OK"
  } ]
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 响应成功。   |
| 400 | 客户端请求有误 |
| 401 | 鉴权失败    |
| 500 | 内部错误    |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
