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

Atlas 备份导出作业创建

在此页面上

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

将 M10 或更高版本的 Atlas 集群的一个备份快照导出到现有 Amazon Web Services S3 存储桶。

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

命令语法
atlas backups exports jobs create [options]
名称
类型
必需
说明

--bucketId

字符串

true

Atlas 分配给存储桶的唯一标识符。

--clusterName

字符串

true

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

--customData

key=value

false

要包含在名为 .complete 的元数据文件中的自定义数据 导出作业完成时 Atlas 上传到存储桶的文件。 自定义数据可以指定为键值对。

-h,--help

false

创建帮助

-o, --output

字符串

false

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

--projectId

字符串

false

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

--snapshotId

字符串

true

快照的唯一标识符。

名称
类型
必需
说明

-P, --profile

字符串

false

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

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

Export job '<Id>' created in a bucket with ID '<ExportBucketId>'.
# The following command exports one backup snapshot of the ExampleCluster cluster to an existing AWS S3 bucket:
atlas backup export jobs create --clusterName ExampleCluster --bucketId 62c569f85b7a381c093cc539 --snapshotId 62c808ceeb4e021d850dfe1b --customData name=test,info=test

后退

作业