Docs Menu
Docs Home
/ /
Atlas CLI
/ /

Atlas アラートの説明

項目一覧

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

プロジェクトの指定されたアラートの詳細を返します。

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

コマンド構文
atlas alerts describe <alertId> [options]
名前
タイプ
必須
説明
alertId
string
true
説明するアラートの一意の識別子。
名前
タイプ
必須
説明
-h, --help
false
説明用のヘルプ
-o, --output
string
false
出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。
--projectId
string
false
使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。

ID TYPE METRIC STATUS
<Id> <EventTypeName> <MetricName> <Status>
# Return the JSON-formatted details for the alert with the ID 5d1113b25a115342acc2d1aa in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas alerts describe 5d1113b25a115342acc2d1aa --projectId 5e2211c17a3e5a48f5497de3 --output json

戻る

確認する