Documentation
auditlog.get
説明
integer/array auditlog.get(object parameters)
このメソッドは、与えられたパラメーターに従って監査ログレコードを取得することができます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 目的の出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートしています。
| パラメーター | タイプ | 説明 |
|---|---|---|
| auditids | ID/array | 指定されたIDの監査ログのみを返します。 |
| userids | ID/array | 指定されたユーザーによって作成された監査ログのみを返します。 |
| time_from | timestamp | 指定された時刻以降に作成された監査ログのみを返します。 |
| time_till | timestamp | 指定された時刻以前に作成された監査ログのみを返します。 |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 利用可能な値: auditid、userid、clock |
| countOutput | boolean | これらのパラメーターについては、リファレンスの解説で説明されています。 |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
監査ログの取得
最新の監査ログレコードを2件取得します。
{ "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() in ui/include/classes/api/services/CAuditLog.php.