Atlas バックアップ スナップショット監視
プロジェクト内の指定されたスナップショットが使用可能になるまで監視します。
このコマンドは、スナップショットのステータスが完了または失敗のステータスに達するまで、定期的にチェックします。 スナップショットが期待どおりのステータスに達すると、コマンドは「スナップショットの変更が完了しました」と表示します。 ターミナルで コマンドを実行すると、リソースのステータスが完了または失敗するまで、ターミナルセッションがブロックされます。 CTRL-C を使用すると、コマンドのポーリングはいつでも中断できます。
このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。
構文
コマンド構文
atlas backups snapshots watch <snapshotId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
snapshotId | string | true | 監視するスナップショットのユニーク識別子。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
-h, --help | false | 監視用のヘルプ | |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Snapshot changes completed.
例
# Watch the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 in the cluster named myDemo until it becomes available: atlas backups snapshots watch 5f4007f327a3bd7b6f4103c5 --clusterName myDemo