为您的项目、集群和作业返回一个云备份导出作业。
公共预览版:从MongoDB Atlas Admin API自动生成的 atlas api 子命令提供了对 Admin API的全面覆盖,目前处于公共预览阶段(请通过以下网址提供反馈: https:// 反馈.mongodb.com/ forum/930808 -atlas-cli )。 Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
atlas backups exports jobs describe [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--clusterName | 字符串 | true | 集群名称。 要了解更多信息,请参阅 https://dochub.mongodb.org/core/create-cluster-api。 |
--exportId | 字符串 | false | 用于标识导出快照的 AWS S3 存储桶的唯一字符串。 与 --bucketId 互斥。 |
-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 EXPORT BUCKET ID STATE SNAPSHOT ID <Id> <ExportBucketId> <State> <SnapshotId>
示例
# Return the details for the continuous backup export job with the ID 5df90590f10fab5e33de2305 for the cluster named Cluster0: atlas backup exports jobs describe --clusterName Cluster0 --exportID 5df90590f10fab5e33de2305