获取

描述

integer/array auditlog.get(object parameters)

该方法允许根据给定的参数检索审计日志。

此方法只有 Super admin(超级管理员) 用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 类型 描述
auditids string/array 仅返回具有给定 ID 的 audit log。
userids string/array 仅返回由给定用户创建的 audit log。
time_from timestamp 仅返回在给定时间之后或在给定时间创建的 audit log。
time_till timestamp 仅返回在给定时间之前或指定时间创建的 audit log。
sortfield string/array 根据给定的属性排序结果。

可能的值：auditid， userid， clock。
filter object 仅返回与给定 filter 完全匹配的结果。

接受一个数组，其中键是属性名称，并且值是要与之匹配的单个值或值数组。

另外支持按属性字段过滤：table_name， field_name。
search object 字段内容中的子字符串搜索：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) 返回以下任一选项：

  • 对象数组；
  • 如果使用了 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() in ui/include/classes/api/services/CAuditLog.php.