MongoDB インスタンスの監査ログをクエリします。
操作説明
この操作を呼び出す際は、インスタンスの監査ログ機能が有効になっていることを確認してください。有効になっていない場合、操作は空の監査ログを返します。
この操作は、汎用ローカルディスクインスタンスおよび専用ローカルディスクインスタンスにのみ適用されます。
この操作は、1 分あたり最大 30 回呼び出すことができます。より高い頻度でこの操作を呼び出すには、Logstore を使用してください。詳細については、「Logstore の管理」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dds:DescribeAuditRecords |
get |
*dbinstance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBInstanceId |
string |
必須 |
インスタンス ID。 説明
このパラメーターをシャードクラスターインスタンスの ID に設定する場合は、NodeId パラメーターも指定する必要があります。 |
dds-bp12c5b040dc**** |
| NodeId |
string |
任意 |
シャードクラスターインスタンス内の Mongos ノードまたはシャードノードの ID。 説明
このパラメーターは、DBInstanceId がシャードクラスターインスタンスの ID に設定されている場合にのみ使用できます。 |
d-bp128a003436**** |
| StartTime |
string |
必須 |
クエリする時間範囲の開始時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は UTC である必要があります。 |
2019-03-13T12:11:14Z |
| EndTime |
string |
必須 |
クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は UTC である必要があります。 説明
開始時刻と終了時刻の間の時間範囲は 24 時間を超えることはできません。超えた場合、操作は失敗します。 |
2019-03-13T13:11:14Z |
| Database |
string |
任意 |
データベースの名前。デフォルトでは、すべてのデータベースがクエリされます。 |
database**** |
| User |
string |
任意 |
データベースアカウント。デフォルトでは、すべてのアカウントがクエリされます。 |
test |
| Form |
string |
任意 |
返される監査レコードのフォーマット。有効な値:
説明
File パラメーターは非推奨です。 |
Stream |
| QueryKeywords |
string |
任意 |
クエリのキーワード。最大 10 個のキーワードを指定できます。複数のキーワードはスペースで区切ります。 |
slow |
| LogicalOperator |
string |
任意 |
キーワード検索の論理演算子。デフォルト値は and です。 |
and |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。有効な値:30 (デフォルト)、50、100。 |
30 |
| PageNumber |
integer |
任意 |
返すページ番号。値は 0 より大きく、整数データ型の最大値を超えてはなりません。デフォルト値:1。 |
1 |
| OrderType |
string |
任意 |
返される監査ログエントリを時間でソートする順序。有効な値:
|
asc |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| TotalRecordCount |
integer |
エントリの総数。 |
40 |
| PageRecordCount |
integer |
現在のページのエントリ数。 |
30 |
| RequestId |
string |
リクエスト ID。 |
3278BEB8-503B-4E46-8F7E-D26E040C9769 |
| PageNumber |
integer |
ページ番号。 |
1 |
| Items |
object |
||
| SQLRecord |
array<object> |
監査ログの詳細リスト。 |
|
|
object |
監査ログエントリの詳細。 |
||
| HostAddress |
string |
クライアントの IP アドレス。 |
11.xxx.xxx.xxx |
| TableName |
string |
MongoDB コレクションの名前。 |
C1 |
| ReturnRowCounts |
integer |
返された行数。 |
2 |
| DBName |
string |
データベース名。 |
test123 |
| ExecuteTime |
string |
文が実行された時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。 |
2019-03-11T03:30:27Z |
| ThreadID |
string |
スレッド ID。 |
140682188297984 |
| TotalExecutionTimes |
integer |
実行時間 (マイクロ秒)。 |
700 |
| Syntax |
string |
実行された文。 |
{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" } |
| AccountName |
string |
データベースアカウントの名前。 |
test |
例
成功レスポンス
JSONJSON
{
"TotalRecordCount": 40,
"PageRecordCount": 30,
"RequestId": "3278BEB8-503B-4E46-8F7E-D26E040C9769",
"PageNumber": 1,
"Items": {
"SQLRecord": [
{
"HostAddress": "11.xxx.xxx.xxx",
"TableName": "C1",
"ReturnRowCounts": 2,
"DBName": "test123",
"ExecuteTime": "2019-03-11T03:30:27Z",
"ThreadID": "140682188297984",
"TotalExecutionTimes": 700,
"Syntax": "{ \\\"atype\\\" : \\\"createCollection\\\", \\\"param\\\" : { \\\"ns\\\" : \\\"123.test1\\\" }, \\\"result\\\": \\\"OK\\\" }",
"AccountName": "test"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidStartTime.Format | Specified start time is not valid. | |
| 400 | InvalidEndTime.Format | Specified end time is not valid. | |
| 400 | InvalidEndTime.Invalid | Specified end time is before this service active time. | |
| 400 | InvalidParameterCombination | The end time must be greater than the start time. | |
| 400 | InvalidQueryKeyword.Format | Specified Query Keyword is not valid. | |
| 400 | InvalidDatabase.Format | Specified Database is not valid. | |
| 400 | InvalidQueryTime.Format | Specified query time is not valid. | |
| 403 | IncorrectSQLLogActiveStatus | Current DB instance SQL log active status does not support this operation. | |
| 403 | LogApiFrequencyExceeded | Exceeding the allowed frequency of log api. | |
| 403 | ConcurrentTaskExceeded | Concurrent task exceeding the allowed amount. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。