公开预览版:请提供反馈:返回请求的服务帐户或API密钥有权访问权限的所有组织。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,全面覆盖 Admin API ,目前处于公共预览版(请通过以下网址提供反馈:https://反馈.mongodb.com/forums/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
要使用此资源,请求的服务账户或 API 密钥必须具有组织成员角色。
此命令是自动生成的,对应 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-listorganizations 。
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api organizations listOrganizations [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
-h,--help | false | listOrganizations 帮助 | |
--includeCount | false | 标志,用于指示响应是否返回响应中的列项总数 (totalCount)。 | |
--itemsPerPage | int | false | 响应每页返回的列项数。 |
--name | 字符串 | false | 组织的人类可读标签,用于过滤返回的列表。对以指定名称为前缀的组织执行不区分大小写的搜索。 |
-o, --output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pageNum | int | false | 显示响应返回的当前总对象集的页面编号。 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--version | 字符串 | false | 进行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。 |