为 AWS S3 存储桶、 Azure Blob 存储容器或 Google Cloud Storage 存储桶创建快照导出存储桶。
atlas api 子命令是从MongoDB Atlas Admin API自动生成的，并提供对 Admin API的全面覆盖。 Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
创建后，可以将快照导出到导出存储桶及其引用的Amazon Web Services S3 存储桶、 Azure Blob 存储容器或Google Cloud Platform存储桶。 要使用此资源，请求的服务帐户或API密钥必须具有项目所有者角色。
1此命令是自动生成的，对应:1 与Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/ operation-creategroupbackupexportbucket。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api cloudBackups createExportBucket [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--file | 字符串 | false | API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | createExportBucket 帮助 | |
-o, --output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"、"2024-05-30"]，默认为最新版本或配置文件 api_version配置值，如果设立此值，则默认为 "2024-05-30"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
AWS
创建以下文件并将其另存为 payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592", "requirePrivateNetworking": false }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api cloudBackups createExportBucket --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
AWS
创建以下文件并将其另存为 payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592", "requirePrivateNetworking": false }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
AZURE
创建以下文件并将其另存为 payload.json
{ "bucketName": "examplecontainer", "cloudProvider": "AZURE", "roleId": "668c5f0ed436263134491592", "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
GCP
创建以下文件并将其另存为 payload.json
{ "bucketName": "export-bucket", "cloudProvider": "GCP", "roleId": "668c5f0ed436263134491592" }
创建 payload.json 后，在同一目录中运行以下命令。
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8