atlas clusters onlineArchives watch
Watch for an archive to be available.
This command checks the archive's status periodically until it reaches a state different from PENDING or PAUSING. Once the archive reaches the expected status, the command prints "Online archive available." If you run the command in the terminal, it blocks the terminal session until the resource status changes to the expected status. You can interrupt the command's polling at any time with CTRL-C.
このコマンドを使用するには、ユーザーアカウントまたはプロジェクト読み取り専用ロールの API キーで認証する必要があります。
構文
atlas clusters onlineArchives watch <archiveId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
archiveId | string | true | Unique identifier of the online archive to watch. |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | false | クラスターの名前。 詳細については、 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 は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Online archive available.
例
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample