実験的な : すべてのアラートを返します。
これらのアラートは、1 つのプロジェクト内のすべてのコンポーネントに適用されます。モニター対象のコンポーネントが設定した値を満たすか超過すると、アラートを受け取ります。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。このリソースは現在も改訂中であり、変更される可能性があります。このコマンドは、OpsID: 'listAlerts' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Alerts/操作/ listAlerts
構文
atlas api alerts listAlerts [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | listAlerts のヘルプ | |
--includeCount | false | レスポンスがレスポンス内の項目の総数（totalCount）を返すかどうかを示すフラグ | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりの項目の数 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pageNum | 整数 | false | レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--status | string | false | 返すアラートのステータス |
--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 を参照してください。 |