2.检索审计日志

描述

integer/array auditlog.get(object **parameters**)

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

参数

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

该方法接受以下参数。

参数类型描述
auditidsstring/array仅返回具有给定ID的审计日志。
useridsstring/array仅返回由给定用户创建的审计日志。
time_fromtimestamp仅返回在给定时间之后或在给定时间创建的审计日志项。
time_tilltimestamp仅返回在给定时间之前或指定时间创建的审计日志项。
selectDetailsquery返回每个字段更改为的审计日志项如细节 属性.

仅适用于带动作项 “1 - 更新”, 对于其他类型的操作,返回空数组。
sortfieldstring/array按给定属性对结果进行排序。

取值: auditid, userid, clock.
filterobject仅返回与给定过滤器完全匹配的结果。

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

另外支持按属性字段过滤: table_name, field_name.
searchobject字段内容中的子字符串搜索: note, ip, resourcename, oldvalue, newvalue不区分大小写。
countOutputboolean该参数对于参考注释中描述的所有get方法都是通用的。
excludeSearchboolean
limitinteger
outputquery
preservekeysboolean
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 传回:

  • 对象数组;

  • 如果使用 countOutput 参数,则为检索到的对象的计数。

示例

检索审计日志

检索两个最新的审计日志记录。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "auditlog.get",
  4. "params": {
  5. "output": "extend",
  6. "sortfield": "clock",
  7. "sortorder": "DESC",
  8. "limit": 2
  9. },
  10. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  11. "id": 1
  12. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "auditid": "189",
  6. "userid": "1",
  7. "clock": "1580913141",
  8. "action": "3",
  9. "resourcetype": "0",
  10. "note": "",
  11. "ip": "127.0.0.1",
  12. "resourceid": "0",
  13. "resourcename": ""
  14. },
  15. {
  16. "auditid": "188",
  17. "userid": "1",
  18. "clock": "1580903029",
  19. "action": "3",
  20. "resourcetype": "0",
  21. "note": "",
  22. "ip": "127.0.0.1",
  23. "resourceid": "0",
  24. "resourcename": ""
  25. }
  26. ],
  27. "id": 2
  28. }

检索在oldvalue字段中具有子字符串“test”的审计日志记录。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "auditlog.get",
  4. "params": {
  5. "output": ["auditid", "resourcename"],
  6. "search": {
  7. "newvalue": "test"
  8. },
  9. "selectDetails": "extend"
  10. },
  11. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  12. "id": 1
  13. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "auditid": "5",
  6. "resourcename": "Mattermost2",
  7. "details": [
  8. {
  9. "table_name": "media_type",
  10. "field_name": "event_menu_url",
  11. "oldvalue": "http://test",
  12. "newvalue": "http://test{EVENT.TAGS.__test}"
  13. }
  14. ]
  15. },
  16. {
  17. "auditid": "7",
  18. "resourcename": "Email",
  19. "details": [
  20. {
  21. "table_name": "media_type",
  22. "field_name": "name",
  23. "oldvalue": "Email",
  24. "newvalue": "Email test"
  25. }
  26. ]
  27. }
  28. ],
  29. "id": 20
  30. }

参见

来源

CAuditLog::get() in ui/include/classes/api/services/CAuditLog.php.