在 MongoDB Cloud 中创建一个组织,并将其与请求的服务账户或 API 密钥所属的组织相关联。
atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的,并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期,您可以通过提供的API终结点文档链接进行检查。
发出请求的服务账户或 API 密钥所属的组织必须是付费组织。要了解更多信息,请参阅 MongoDB Atlas 文档中的配置付费组织。可选地,如果提供 federationSettingsId,则新组织将链接到联邦。请求的服务账户或 API 密钥必须是联邦中的 Organization Owner。
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-createorg.
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api organizations createOrg [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--file | 字符串 | false | API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一,但不能同时提供两者。 |
-h,--help | false | createOrg 帮助 | |
-o, --output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--version | 字符串 | false | 调用 Atlas API 终结点时要使用的 API 版本 [选项:"2023-01-01"]。如果用户未设置,则默认为最新版本,或者如果已设置了配置文件的 api_version 值,则默认为该值。此值默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |