実験的な : 指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮（.gz）ログファイルを返します。
MongoDB は5 分ごとにクラスターバックエンドストラクチャからのプロセス ログと監査するログを更新します。ログは長さが約 5 分のチャンクで保存されますが、この期間は異なる場合があります。ログファイルのAPIをポーリングする場合は、連続するポーリングに重複するログが含まれる可能性があっても、5 分ごとにポーリングすることをお勧めします。この機能は、M0 無料クラスター、M2、M5、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。API は、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエスト必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。このコマンドは、OpsID: 'getHostLogs' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Monitoring-and- Logs/ 操作/getHostLogs
構文
atlas api monitoringAndLogs getHostLogs [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--endDate | 整数 | false | は、検索するログメッセージの範囲の終了点の日付と時刻を、UNIX エポックからの経過秒数で指定します。 |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | getHostLogs のヘルプ | |
--hostName | string | true | ダウンロード対象のログファイルを保存するホストを識別する、人間が判読できるラベル |
--logName | string | true | 返却対象のログファイルを識別する、人間が判読できるラベル |
--出力 | string | false | 優先 API形式 は、 ["gzip"] にすることができます。この値のデフォルトは "gzip" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--startDate | 整数 | false | は、検索するログメッセージの範囲の開始点の日付と時刻を、UNIX エポックからの経過秒数で指定します。 |
--version | string | false | API 呼び出しで使用する API バージョン [options: "2023-01-01", "2023-02-01"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2023-02-01" になります。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |