実験的な : 指定されたプロジェクトのすべてのイベントを返します。
イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。このリソースは現在も改訂中であり、変更される可能性があります。このコマンドは、OpsID: 'listProjectEvents' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Events/ 操作/ listProjectEvents
構文
atlas api events listProjectEvents [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterNames | stringArray | false | クラスターを識別する、人間が判読できるラベル |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--eventType | stringArray | false | 現時点で記録されたインシデントのカテゴリ |
-- excludedEventType | stringArray | false | クエリ結果から除外するイベントのカテゴリ（CLUSTER_CREATED など） 重要: イベントタイプ名は頻繁に変更されます |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | listProjectEvents のヘルプ | |
--includeCount | false | レスポンスがレスポンス内の項目の総数（totalCount）を返すかどうかを示すフラグ | |
--includeRaw | false | 未加工のドキュメントを出力に含めるかどうかを示すフラグ | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりの項目の数 |
--maxDate | string | false | MongoDB Cloud がイベントの返送を停止する日時 |
--minDate | string | false | MongoDB Cloud がイベントの返送を開始する日時 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pageNum | 整数 | false | レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--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 を参照してください。 |