auditlog.get
描述
integer/array auditlog.get(object parameters)
该方法允许根据给定参数检索审计日志记录。
此方法仅适用于超级管理员用户类型。 调用该方法的权限可在用户角色设置中撤销。详见 User roles 获取更多信息。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| auditids | string/array | 仅返回具有给定ID的审计日志。 |
| userids | string/array | 仅返回由给定用户创建的审计日志。 |
| time_from | timestamp | 仅返回在指定时间之后或等于该时间创建的审计日志条目。 |
| time_till | timestamp | 仅返回在指定时间之前或等于该时间创建的审计日志条目。 |
| sortfield | string/array | 按给定属性对结果进行排序。 可能的值为： auditid, userid, clock。 |
| filter | object | 仅返回与给定筛选条件完全匹配的结果。 接受一个array，其中键为属性名称，值为单个值或要匹配的值的array。 |
| search | object | 在以下字段内容中进行不区分大小写的子string搜索：username, ip, resourcename, details。 |
| countOutput | boolean | 这些参数在通用get方法参数中有描述。 |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下两种情况之一:
- 一个包含array的objects数组
- 检索到的objects数量（当使用了
countOutput参数时）
示例
检索审计日志
获取最新的两条审计日志记录
请求:
{
"jsonrpc": "2.0",
"method": "auditlog.get",
"params": {
"output": "extend",
"sortfield": "clock",
"sortorder": "DESC",
"limit": 2
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"auditid": "cksstgfam0001yhdcc41y20q2",
"userid": "1",
"username": "Admin",
"clock": "1629975715",
"ip": "127.0.0.1",
"action": "1",
"resourcetype": "0",
"resourceid": "0",
"resourcename": "Jim",
"recordsetid": "cksstgfal0000yhdcso67ondl",
"details": "{\"user.name\":[\"update\",\"Jim\",\"\"],\"user.medias[37]\":[\"add\"],\"user.medias[37].\":[\"add\"],\"user.medias[37].mediatypeid\":[\"add\",\"1\"],\"user.medias[37].sendto\":[\"add\",\"[email protected]\"]}"
},
{
"auditid": "ckssofl0p0001yhdcqxclsg8r",
"userid": "1",
"username": "Admin",
"clock": "1629967278",
"ip": "127.0.0.1",
"action": "0",
"resourcetype": "0",
"resourceid": "20",
"resourcename": "John",
"recordsetid": "ckssofl0p0000yhdcpxyo1jgo",
"details": "{\"user.username\":[\"add\",\"John\"], \"user.userid:\":[\"add\",\"20\"],\"user.usrgrps[28]\":[\"add\"],\"user.usrgrps[28].usrgrpid\":[\"add\", \"7\"]}"
}
],
"id": 1
}另请参阅
来源
CAuditLog::get() 位于 ui/include/classes/api/services/CAuditLog.php 文件中。