atlas backups snapshots watch
监视项目中的指定快照,直到其可用。
此命令会定期检查快照的状态,直到其达到已完成或已失败状态。 一旦快照达到预期状态,该命令就会打印“Snapshot Changes completed”(快照更改已完成)。 如果在终端中运行该命令,则会阻止终端会话,直到资源状态完成或失败。 您可以随时使用 Ctrl-C 中断命令的轮询。
要使用此命令,您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas backups snapshots watch <snapshotId> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
snapshotId | 字符串 | true | 要观看的快照的唯一标识符。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--clusterName | 字符串 | true | 集群名称。 要了解详情,请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
-h,--help | false | 监视帮助 | |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.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