创建Atlas Ephemeral集群并返回其连接和声明详细信息。
atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。
临时集群是一种临时的免费集群,无需Atlas帐户即可创建和连接。 Atlas会在创建 2 天后暂停集群,并在创建 7 天后将其删除,除非您将其声明为Atlas账户所有。
声明临时集群会将其转换为没有过期日期的标准免费集群,并将其移动到新的或现有的Atlas组织中。在您声明集群之前,您可以读取和写入其数据,但不能执行管理操作,例如扩展集群、添加数据库用户或更改网络访问权限。
Atlas将所有临时集群部署到 AWS us-east-1,并允许来自任何IP解决(0.0.0.0/0) 的连接。要学习;了解有关临时集群的更多信息,请参阅MongoDB Atlas文档中的创建Atlas临时集群。
此命令是自动生成的,对应 1:1 与Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-createephemeralcluster.
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api ephemeralClusters createEphemeralCluster [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--file | 字符串 | false | API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一,但不能同时提供两者。 |
-h,--help | false | createEphemeralCluster 帮助 | |
-o, --output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--version | 字符串 | false | 调用 Atlas API 终结点时要使用的 API 版本 [选项:"preview"]。如果用户未设置,则默认为最新版本,或者如果已设置了配置文件的 api_version 值,则默认为该值。该值默认为 "preview"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |