実験的な : 指定されたオンラインアーカイブのクエリログをダウンロードします。
このリソースを使用するには、リクエスト元のAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。API は、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエスト必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。このコマンドは、OperationID: ' DownloadOnlineAr ArchiveLogs 'を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /#Tag/Atlas/ 操作/ DownloadOnlineAr ArchiveQueryLogs
構文
atlas api onlineArchive downloadOnlineArchiveQueryLogs [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--archiveOnly | false | クエリのログをオンライン アーカイブのみにダウンロードするか、オンライン アーカイブとクラスターの両方に対してダウンロードするかを示すフラグ | |
--clusterName | string | true | 1 つのオンライン アーカイブからクエリ ログを返却するコレクションを持つクラスターを識別する、人間が判読できるラベル |
--endDate | 整数 | false | 返却対象のログメッセージの範囲の終了点を指定する日時 |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | ダウンロードOnlineAr ArchiveQueryLogs のヘルプ | |
--出力 | string | false | 優先 API形式 は、 ["gzip"] にすることができます。この値のデフォルトは "gzip" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--startDate | 整数 | false | 返却対象のログメッセージの範囲の開始点を指定する日時 |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |