auditlog.get

描述

integer/array auditlog.get(object parameters)

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

此方法仅适用于超级管理员(Super admin)用户类型。 调用该方法的权限可以在用户角色设置中被撤销。更多信息请参见 User roles

参数

(object) 定义期望输出的参数。

该方法支持以下参数。

参数 数据类型 说明
auditids ID/array 仅返回具有指定ID的审计日志。
userids ID/array 仅返回由指定用户创建的审计日志。
time_from timestamp 仅返回在指定时间或之后创建的审计日志条目。
time_till timestamp 仅返回在指定时间或之前创建的审计日志条目。
sortfield string/array 按照指定属性对结果进行排序。

可能的值:auditiduseridclock
countOutput boolean 这些参数在 通用get方法参数 中有详细描述。
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下之一:

  • array 的 objects;
  • 如果使用了 countOutput 参数,则为检索到的 objects 的数量。

示例

检索审计日志

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

执行请求:

{
    "jsonrpc": "2.0",
    "method": "auditlog.get",
    "params": {
        "output": "extend",
        "sortfield": "clock",
        "sortorder": "DESC",
        "limit": 2
    },
    "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 中。