パブリック プレビュー:フィードバックを提供してください : 指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮(.gz)ログファイルを返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
MongoDB は5 分ごとにクラスターバックエンドストラクチャからのプロセス ログと監査するログを更新します。ログは長さが約 5 分のチャンクで保存されますが、この期間は異なる場合があります。ログファイルのAPIをポーリングする場合は、連続するポーリングに重複するログが含まれる可能性があっても、5 分ごとにポーリングすることをお勧めします。この機能は、M0 無料クラスター、M2、M5、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。API は、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエスト必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-gethostlogs 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api monitoringAndLogs getHostLogs [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--endDate | 整数 | false | 検索するログメッセージの範囲の終了点の日時を、UNIX エポックからの経過秒数で指定します。この値は、開始日からデフォルトで 24 時間後に設定されます。開始日も指定されていない場合、値はデフォルトでリクエストの時刻になります。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | getHostLogs のヘルプ | |
--hostName | string | true | ダウンロード対象のログファイルを保存するホストを識別する、人間が判読可能なラベル。 |
--logName | string | true | 返却対象のログファイルを識別する、人間が判読できるラベル。監査ログを返すには、指定されたプロジェクトのデータベース監査を有効にします。 |
-o, --output | string | false | 優先 API形式 は、 ["gzip"] にすることができます。この値のデフォルトは "gzip" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--startDate | 整数 | false | 取得するログメッセージの範囲の開始点の日時を、UNIX エポックからの経過秒数で指定します。この値は、デフォルトでは終了日の 24 時間前に設定されます。終了日も指定されていない場合、値はデフォルトでリクエストの時刻の 24 時間前になります。 |
--version | string | false | API 呼び出しで使用する API バージョン [options: "2023-01-01", "2023-02-01"] は、デフォルトで最新バージョンまたはプロファイル api_version設定されている場合の構成値この値はデフォルトで "2023-02-01" になります。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
例
atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200