実験的な : 指定されたプロジェクトで指定されたアラート構成を有効または無効にします。
リソースは、指定されたアラート構成が現在有効になっている場合は有効にします。リソースは、指定されたアラート構成が現在無効になっている場合は無効にします。このリソースを使用するには、リクエスト元のAPIキーに組織オーナーまたはプロジェクトオーナーのロールが必要です。注: このエンドポイントは、アラート構成の有効/無効状態のみを更新します。この構成以外を更新するには、「 1 つのアラート構成の更新 」を参照してください。このリソースは現在も改訂中であり、変更される可能性があります。このコマンドは、OpsID: 'togileAlertConfiguration' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Alert-Configurations/ を参照してください。 操作/togdleAlertConfiguration
構文
atlas api alertConfigurations toggleAlertConfiguration [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--alertConfigId | string | true | このアラートをトリガーしたアラート構成を識別する一意の 24 桁の 16 進数の文字列 |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--file | string | false | APIリクエストの内容を含むファイルへのパス |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | ヘルプ - で切り替え | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--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 を参照してください。 |