atlas backups snapshots create
为您的项目和集群创建备份快照。
您可以为 Atlas 集群层 M10 及更大创建按需备份快照。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。 Atlas 仅对 M10+ 集群支持此命令。
语法
命令语法
atlas backups snapshots create <clusterName> [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
集群名称 | 字符串 | true | 要恢复其快照的 Atlas 集群的名称。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--desc | 字符串 | true | 按需快照的描述。 |
-h,--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--retention | int | false | Atlas 应保留按需快照的天数。 必须至少为 1。 该值默认为 1。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Snapshot '<Id>' created.
示例
# Create a backup snapshot for the cluster named myDemo that Atlas retains for 30 days: atlas backups snapshots create myDemo --desc "test" --retention 30