アーカイブが利用可能になるかどうかを監視します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在パブリック プレビュー段階です（フィードバックでフィードバックを提供してくださいフォーラム/930808-Atlas-cli）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
このコマンドは、アーカイブのステータスが PENDING または PAUSING とは異なる状態になるまで、定期的にチェックします。 アーカイブが期待どおりのステータスに達すると、コマンドは「オンライン アーカイブが利用可能」と表示されます。 ターミナルで コマンドを実行すると、リソースのステータスが期待どおりのステータスに変わるまで、ターミナルセッションがブロックされます。 CTRL-C を使用すると、コマンドのポーリングはいつでも中断できます。
このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。
構文
atlas clusters onlineArchives watch <archiveId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
archiveId | string | true | 監視するオンライン アーカイブの一意の識別子です。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | false | クラスターの名前。詳細については、https://dochub.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 は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Online archive available.
例
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample