パブリックプレビュー:フィードバックを提供してください : 指定されたアラート構成がトリガーするすべてのオープン アラートを返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
これらのアラート設定は、指定されたプロジェクトにのみ適用されます。アラート設定では、アラートのトリガー条件や通知方法が定義されます。未解決のアラートとは、トリガーされたものの、まだ確認されていない状態のアラートです。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。認証済みユーザーがアクセス可能なすべてのアラート設定を取得するには、"1 つのプロジェクトのすべてのアラート設定を返す（Return All Alert Configurations for One Project）" エンドポイントを使用してください。
このリソースは現在も改訂中であり、変更される可能性があります。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-listalertsbyalertconfigurationid 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api alerts listAlertsByAlertConfigurationId [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--alertConfigId | string | true | アラート設定を識別する一意の 24 桁の 16 進数文字列です。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | listAlertsByAlertConfigurationId のヘルプ | |
--includeCount | false | レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。 | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりのアイテムの数。 |
-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 alerts listAlertsByAlertConfigurationId --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8