Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas アラート設定リスト

項目一覧

  • 構文
  • オプション
  • 継承されたオプション

プロジェクトのすべてのアラート構成を返します。

このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。

コマンド構文
atlas alerts settings list [options]
名前
タイプ
必須
説明
-c, --compact
false
JSON出力の圧縮された配列応答構造を有効にするフラグ。 -- compact オプションは、配列オブジェクトを最上位の応答として返し、以前の CLI バージョンに基づくスクリプトの下位互換性を確保します。 JSON出力の -- compact オプションを省略すると、「結果」サブ配列内の配列オブジェクトが返されます。 このオプションを使用するには --出力JSONを指定する必要があります。
-h, --help
false
リスト用のヘルプ
--limit
整数
false
結果ページあたりの項目数。最大 500 まで。 500 を超える結果がある場合は、結果ページを変更するために --page オプションを指定します。 この値のデフォルトは 100 です。
-o, --output
string
false
出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。
--page
整数
false
結果のページを指定するページ番号。 この値のデフォルトは 1 です。
--projectId
string
false
使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。
# Return a JSON-formatted list of all alert configurations for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings list --projectId 5df90590f10fab5e33de2305 --output json

戻る

タイプ