Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

Atlas API cloudBackupstakeSnapshot

实验:为指定集群拍摄一张按需快照。

Atlas会立即按需,并定期拍摄计划快照。如果存在状态为“已排队”或“进行中”的按需快照,则在拍摄另一张快照之前,请等待Atlas完成对先前拍摄的按需的快照。要使用此资源,请求的API密钥必须具有“项目所有者”角色。此命令正在调用 OperationID 为“takeSnapshot”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Cloud-Backups/operation/takeSnapshot

命令语法
atlas api cloudBackups takeSnapshot [options]
名称
类型
必需
说明

--clusterName

字符串

true

用于标识集群的人类可读标签

--envelope

false

标志,指示应用程序是否将响应包装在信封JSON对象中

--file

字符串

false

包含API请求内容的文件的路径

--groupId

字符串

true

用于标识项目的唯一 24-十六进制数字字符串

-h,--help

false

takeSnapshot 帮助

--output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--output-file

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--pretty

false

标志,指示响应正文是否应采用美观打印格式

--version

字符串

false

进行API调用时要使用的API版本 [选项:"2023-01-01"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2023-01-01"。

名称
类型
必需
说明

-P, --profile

字符串

false

后退

listShardedClusterBackups

在此页面上