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 按指定属性排序结果。

可选值包括:auditiduseridclock
filter object 仅返回与给定筛选条件完全匹配的结果。

接受一个array,其中键为属性名称,值为要匹配的单个值或array值集合。
search object 在以下字段内容中执行不区分大小写的子string搜索:usernameipresourcenamedetails
countOutput boolean 这些参数在通用get方法参数中有详细描述。
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下两种结果之一:

  • 一个包含objects的array;
  • 若使用了countOutput参数,则返回检索到的objects数量。

示例

检索审计日志

获取最新的两条审计日志记录。

请求:

{
           "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 文件中。