MongoDB インスタンスの実行中ログを表示します。
操作説明
この API は、以下の仕様タイプのインスタンスに対応しています:汎用ローカルディスク、専有ローカルディスク、および クラウドディスク。
この API は 1 分あたり最大 30 回の呼び出しが可能です。この上限を超えるとレート制限が適用されるため、高頻度での呼び出しは避けてください。高頻度操作が必要な場合は、Logstore を使用してください。詳細については、「Logstore の管理」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dds:DescribeRunningLogRecords |
get |
*dbinstance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBInstanceId |
string |
必須 |
インスタンス ID。 説明
このパラメーターにシャードクラスターインスタンスの ID を指定する場合、NodeId パラメーターも指定する必要があります。 |
dds-bpxxxxxxxx |
| NodeId |
string |
任意 |
シャードクラスターインスタンス内の Mongos ノードまたはシャードノードの ID。 説明
このパラメーターは、DBInstanceId パラメーターにシャードクラスターインスタンスの ID を指定した場合のみ使用できます。 |
d-bpxxxxxxxx |
| StartTime |
string |
必須 |
クエリ対象の時間範囲の開始時刻。yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は協定世界時 (UTC) です。 |
2019-01-01T12:10Z |
| EndTime |
string |
必須 |
クエリ対象の時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は協定世界時 (UTC) です。 説明
終了時刻は開始時刻から最大 24 時間後まで指定できます。これを超えると、呼び出しは失敗します。 |
2019-01-01T13:10Z |
| DBName |
string |
任意 |
データベース名。 |
mongodbtest |
| RoleType |
string |
任意 |
ノードのロール。有効値:
説明
NodeId パラメーターに Mongos ノードの ID を指定する場合、RoleType パラメーターには primary のみを指定できます。 |
primary |
| PageSize |
integer |
任意 |
1 ページあたりの取得件数。有効値:30 ~ 100。 |
30 |
| PageNumber |
integer |
任意 |
取得対象のページ番号。0 より大きい整数を指定します。デフォルト値:1。 |
1 |
| OrderType |
string |
任意 |
返される実行中ログのソート順。有効値:
|
asc |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
sg-bpxxxxxxxxxxxxxxxxxx |
| RoleId |
string |
任意 |
ノードのロール ID。DescribeReplicaSetRole 操作を呼び出して、ロール ID を照会できます。 |
651xxxxx |
| QueryKeywords |
string |
任意 |
クエリキーワード。最大 10 個のキーワードを指定できます。複数のキーワードは半角スペースで区切ります。 |
test test2 |
| LogicalOperator |
string |
任意 |
キーワードベースのクエリで使用する論理演算子。デフォルト値: |
and |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| TotalRecordCount |
integer |
レコードの総数。 |
2 |
| PageRecordCount |
integer |
1 ページあたりのレコード数。 |
30 |
| RequestId |
string |
リクエスト ID。 |
45D2B592-DEBA-4347-BBF3-47FF6C97DBBC |
| PageNumber |
integer |
ページ番号。 |
1 |
| Items |
object |
||
| LogRecords |
array<object> |
実行中ログレコードのリスト。 |
|
|
object |
|||
| ConnInfo |
string |
接続情報。 |
conn18xxxxxx |
| CreateTime |
string |
ログエントリの作成時刻 (yyyy-MM-ddTHH:mm:ssZ 形式、協定世界時 (UTC))。 |
2019-02-26T12:09:34Z |
| Category |
string |
ログカテゴリ。 |
NETWORK |
| Content |
string |
ログエントリの内容。 |
end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\n |
| Engine |
string |
データベースエンジン。 |
MongoDB |
例
成功レスポンス
JSONJSON
{
"TotalRecordCount": 2,
"PageRecordCount": 30,
"RequestId": "45D2B592-DEBA-4347-BBF3-47FF6C97DBBC",
"PageNumber": 1,
"Items": {
"LogRecords": [
{
"ConnInfo": "conn18xxxxxx",
"CreateTime": "2019-02-26T12:09:34Z",
"Category": "NETWORK",
"Content": " end connection 11.xxx.xxx.xx:3xxxx (0 connections now open)\\n"
}
]
},
"Engine": "MongoDB"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameterCombination | The end time must be greater than the start time | |
| 400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | |
| 403 | LogApiFrequencyExceeded | Exceeding the allowed frequency of log api. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。