Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

atlas backups snapshots list

在此页面上

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 输出
  • 示例

返回项目和集群的所有云备份快照。

要使用此命令,您必须使用具有“项目只读”角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas backups snapshots list <clusterName> [options]
名称
类型
必需
说明

集群名称

字符串

true

包含要检索的快照的 Atlas 集群的名称。

名称
类型
必需
说明

-h,--help

false

列表帮助

--limit

int

false

每个结果页面的列项数,最多 500 个。 如果结果超过 500 个,请指定 --page 选项以更改结果页面。 此值默认为 100。

--omitCount

false

指示 JSON 响应是否返回 JSON 响应中的项目总数 (totalCount) 的标志。

-o, --output

字符串

false

输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。

--page

int

false

指定结果页面的页码。 该值默认为 1。

--projectId

字符串

false

标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。

名称
类型
必需
说明

-P, --profile

字符串

false

要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

ID TYPE STATUS CREATED AT EXPIRES AT
<Id> <SnapshotType> <Status> <CreatedAt> <ExpiresAt>
# Return a JSON-formatted list of snapshots for the cluster named myDemo
atlas backups snapshots list myDemo --output json

后退

描述