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

atlas backups snapshot describe

在此页面上

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

返回项目指定快照的详细信息。

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

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

snapshotId

字符串

true

要检索的快照的唯一标识符。

名称
类型
必需
说明

--clusterName

字符串

true

集群名称。 要了解详情,请参阅 https://dochub.mongodb.org/core/create-cluster-api。

-h,--help

false

描述帮助

-o, --output

字符串

false

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

--projectId

字符串

false

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

名称
类型
必需
说明

-P, --profile

字符串

false

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

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

ID SNAPSHOT TYPE TYPE DESCRIPTION EXPIRES AT
<Id> <SnapshotType> <Type> <Description> <ExpiresAt>
# Return the details for the backup snapshot with the ID 5f4007f327a3bd7b6f4103c5 for the cluster named myDemo:
atlas backups snapshots describe 5f4007f327a3bd7b6f4103c5 --clusterName myDemo

后退

删除