公共预览版:请在以下位置提供反馈:返回指定组织中的多个项目。
每个组织可以有多个项目。使用项目来:
将不同环境(如开发环境、测试环境或生产环境)相互隔离。
将不同的 MongoDB Cloud 用户或团队与不同的环境关联,或者为不同环境中的 MongoDB Cloud 用户授予不同权限。
维护单独的集群安全配置。
创建不同的警报设置。
要使用此资源,请求的 API 密钥必须具有“组织成员”角色。
1此命令是自动生成的,对应:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2 /# 标签/Organizations/ operation/listOrganizationProjects。
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api organizations listOrganizationProjects [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
-h,--help | false | listOrganizationProjects 的帮助 | |
--includeCount | false | 标志,用于指示响应是否返回响应中的列项总数 (totalCount)。 | |
--itemsPerPage | int | false | 响应每页返回的列项数。 |
--name | 字符串 | false | 项目的人类可读标签,用于过滤返回的列表。对以指定名称为前缀的组织内的项目执行不区分大小写的搜索。 |
--orgId | 字符串 | true | 唯一的 24-十六进制数字字符串,用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。 |
--output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pageNum | int | false | 显示响应返回的当前总对象集的页面编号。 |
--pretty | false | 指示响应正文是否应位于 <a href=" https://en.wikipedia.org/wiki/Prettyprint "target="_blank" rel="noopener noreferrer">pretty-print</a> 格式。 | |
--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. |
示例
运行以下命令。
atlas api organizations listOrganizationProjects --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false