この API を呼び出して、MongoDB インスタンスの監査ログのレコードをクエリできます。

この API を呼び出すときは、インスタンスの監査ログ機能が有効になっていることが必要です。 そうでなければ、API は空の監査ログを返します。

注 この API は、レプリカセットインスタンスとシャードクラスタインスタンスの両方をサポートします。 DescribeAuditRecords は、スタンドアロンインスタンスでは実行できません。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ データ型 必須 例 説明
Action String はい DescribeAuditRecords

実行する操作。 値を DescribeAuditRecords に設定します。

StartTime String はい 2019-03-13T12:11:14Z

クエリの開始時刻。 時刻形式：yyyy-MM-ddTHH:mm:ssZ。

EndTime String はい 2019-03-13T13:11:14Z

クエリの終了時刻。 時刻形式：yyyy-MM-ddTHH:mm:ssZ。

DBInstanceId String はい dds-bpxxxxxxxx

インスタンスの ID

注 このパラメーターをシャードクラスターインスタンスの ID に指定する場合は、 NodeId パラメータを指定する必要があります。
NodeId String いいえ d-bpxxxxxxxx

指定されたシャードクラスターインスタンス内の mongos またはシャードの ID。

注 このパラメーターは、シャードクラスターインスタンスの ID に DBInstanceId パラメーターを指定した場合にのみ有効です。
Database String いいえ testdatabase

データベースの名前。 このパラメーターを指定しない場合、この API はすべてのデータベースのレコードを返します。

User String いいえ root

データベースのユーザー。 このパラメーターを指定しない場合、この API はすべてのユーザーのレコードを返します。

Form String いいえ Stream

API より返される監査ログの形式。 有効値：

  • File：監査ログの生成をトリガーします。 このパラメーターが File に設定されている場合、共通パラメーターのみが返されます。 この場合、 DescribeAuditFiles API を呼び出して、監査ログのダウンロードアドレスを取得する必要があります。
  • Stream：データストリームを返します。

デフォルト値：Stream。

QueryKeywords String いいえ slow

クエリに使用されるキーワード。 複数のキーワードはスペースで区切ります。 キーワードの個数は最大 10 個です。

PageSize Integer いいえ 30

各ページの履歴件数。 有効値： 30、50、100。 デフォルト値： 30。

PageNumber Integer No 1

ページ番号 。 有効値：0 以外の正の整数。 デフォルト値：1。

AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 例 説明
Items

監査ログの詳細リスト。

└AccountName String root

データベースのユーザー。

└DBName String test123

データベースの名前。

└ExecuteTime String 2019-03-11T03:30:27Z

ステートメントが実行された時刻。 時刻形式：yyyy-MM-ddTHH:mm:ssZ。

└HostAddress String 11.xxx.xxx.xxx

クライアントの IP アドレス。

turnReturnRowCounts Long 2

返されたレコードの数。

└Syntax String { \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }

実行されたステートメント。

└ThreadID String 140682188297984

スレッドの ID。

└TotalExecutionTimes Long 700

ステートメント実行の期間。 単位：マイクロ秒。

PageNumber Integer 1

ページ番号 。

PageRecordCount Integer 30

現行ページのエントリ数。

RequestId String 3278BEB8-503B-4E46-8F7E-D26E040C9769

リクエストの ID 。

TotalRecordCount Integer 40

レコードの総数

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=DescribeAuditRecords
&StartTime=2019-03-13T12:11:14Z
&EndTime=2019-03-13T13:11:14Z
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<DescribeAuditRecordsResponse>
  <Items>
    <SQLRecord>
      <TotalExecutionTimes>703</TotalExecutionTimes>
      <Syntax>{ "atype" : "command", "param" : { "command" : "find", "ns" : "123.test1", "args" : { "find" : "test1", "filter" : { "x" : 1, "y" : 2 }, "shardVersion" : [ { "$timestamp" : { "t" : 0, "i" : 0 } }, { "$oid" : "000000000000000000000000" } ], "$clusterTime" : { "clusterTime" : { "$timestamp" : { "t" : 1552275017, "i" : 2 } }, "signature" : { "hash" : { "$binary" : "9qfygDs61fKCvdXJqjq+f0zML0E=", "$type" : "00" }, "keyId" : { "$numberLong" : "6666955498811555841" } } }, "$client" : { "application" : { "name" : "MongoDB Shell" }, "driver" : { "name" : "MongoDB Internal Client", "version" : "3.4.10" }, "os" : { "type" : "Linux", "name" : "Ubuntu", "architecture" : "x86_64", "version" : "16.04" }, "mongos" : { "host" : "rxxxxxx.cloud.cm10:3074", "client" : "47.xxx.xxx.xx:53854", "version" : "4.0.0" } }, "$configServerState" : { "opTime" : { "ts" : { "$timestamp" : { "t" : 1552275017, "i" : 2 } }, "t" : { "$numberLong" : "3" } } }, "$db" : "123" } }, "result": "OK" }</Syntax>
      <HostAddress>11.xxx.xxx.xx</HostAddress>
      <ExecuteTime>2019-03-11T03:30:27Z</ExecuteTime>
      <ThreadID>139xxxxxxxx</ThreadID>
      <AccountName>__system;</AccountName>
      <DBName>local;</DBName>
    </SQLRecord>
    <SQLRecord>
      <TotalExecutionTimes>0</TotalExecutionTimes>
      <Syntax>{ "atype" : "createIndex", "param" : { "ns" : "123.test1", "indexName" : "y_1", "indexSpec" : { "v" : 2, "key" : { "y" : 1 }, "name" : "y_1", "ns" : "123.test1" } }, "result": "OK" }</Syntax>
      <HostAddress/>
      <ExecuteTime>2019-03-11T03:30:06Z</ExecuteTime>
      <ThreadID>140xxxxxxxx</ThreadID>
      <AccountName>__system;</AccountName>
      <DBName>local;</DBName>
    </SQLRecord>
  </Items>
  <PageNumber>1</PageNumber>
  <TotalRecordCount>2</TotalRecordCount>
  <RequestId>3278BEB8-503B-4E46-8F7E-D26E040C9769</RequestId>
  <PageRecordCount>30</PageRecordCount>
</DescribeAuditRecordsResponse>

JSON 形式 

{
	"Items":{
		"SQLRecord":[
			{
				"TotalExecutionTimes":703,
				"Syntax":"{ \"atype\" : \"command\", \"param\" : { \"command\" : \"find\", \"ns\" : \"123.test1\", \"args\" : { \"find\" : \"test1\", \"filter\" : { \"x\" : 1, \"y\" : 2 }, \"shardVersion\" : [ { \"$timestamp\" : { \"t\" : 0, \"i\" : 0 } }, { \"$oid\" : \"000000000000000000000000\" } ], \"$clusterTime\" : { \"clusterTime\" : { \"$timestamp\" : { \"t\" : 1552275017, \"i\" : 2 } }, \"signature\" : { \"hash\" : { \"$binary\" : \"9qfygDs61fKCvdXJqjq+f0zML0E=\", \"$type\" : \"00\" }, \"keyId\" : { \"$numberLong\" : \"6666955498811555841\" } } }, \"$client\" : { \"application\" : { \"name\" : \"MongoDB Shell\" }, \"driver\" : { \"name\" : \"MongoDB Internal Client\", \"version\" : \"3.4.10\" }, \"os\" : { \"type\" : \"Linux\", \"name\" : \"Ubuntu\", \"architecture\" : \"x86_64\", \"version\" : \"16.04\" }, \"mongos\" : { \"host\" : \"rxxxxxx.cloud.cm10:3074\", \"client\" : \"47.xxx.xxx.xx:53854\", \"version\" : \"4.0.0\" } }, \"$configServerState\" : { \"opTime\" : { \"ts\" : { \"$timestamp\" : { \"t\" : 1552275017, \"i\" : 2 } }, \"t\" : { \"$numberLong\" : \"3\" } } }, \"$db\" : \"123\" } }, \"result\": \"OK\" }",
				"HostAddress":"11.xxx.xxx.xxx",
				"ExecuteTime":"2019-03-11T03:30:27Z",
				"ThreadID":"139xxxxxxxx",
				"AccountName":"__system;",
				"DBName":"local;"
			},
			{
				"TotalExecutionTimes":0,
				"Syntax":"{ \"atype\" : \"createIndex\", \"param\" : { \"ns\" : \"123.test1\", \"indexName\" : \"y_1\", \"indexSpec\" : { \"v\" : 2, \"key\" : { \"y\" : 1 }, \"name\" : \"y_1\", \"ns\" : \"123.test1\" } }, \"result\": \"OK\" }",
				"HostAddress":"",
				"ExecuteTime":"2019-03-11T03:30:06Z",
				"ThreadID":"140xxxxxxxx",
				"AccountName":"__system;",
				"DBName":"local;"
			}
		]
	},
	"TotalRecordCount":2,
	"PageNumber":1,
	"RequestId":"3278BEB8-503B-4E46-8F7E-D26E040C9769",
	"PageRecordCount":30
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 InvalidEndTime.Format 指定された終了時刻は無効です。 無効な終了時刻を指定したときに返されるエラーメッセージ。 時刻の形式が正しいかどうかをご確認ください。

エラーコードの表示