パブリック プレビュー:フィードバックを提供してください : 指定された組織のイベントを返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
イベントは、データベース、課金、セキュリティのアクティビティやステータスの変更に関する重要な情報を提供します。このリソースを使用するには、リクエストするサービスアカウントまたは API キーに Organization Member のロールが必要です。
このリソースは現在も改訂中であり、変更される可能性があります。
このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 / 操作/operation-listorgません。 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api events listOrganizationEvents [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--eventType | stringArray | false | 現時点で記録されたインシデントのカテゴリ。 IMPORTANT: イベントタイプの値の完全なリストは、頻繁に変更されます。 |
-h, --help | false | listOrganizationEvents のヘルプ | |
--includeCount | false | レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。 | |
--includeRaw | false | 未加工のドキュメントを出力に含めるかどうかを示すフラグ。生のドキュメントには、イベントに関する追加のメタ情報が格納されています。 | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりのアイテムの数。 |
--maxDate | string | false | MongoDB Cloud がイベントを返すことを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。 |
--minDate | string | false | MongoDB Cloud がイベントを返すことを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式を使用します。 |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。 |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | 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 を参照してください。 |
例
atlas api events listOrganizationEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61