公共预览版：请提供反馈：返回您有权访问权限的特定项目中所有集群的详细信息。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，全面覆盖 Admin API ，目前处于公共预览版（请通过以下网址提供反馈：https://反馈.mongodb.com/forums/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
集群包含一组维护相同数据集的主机。该响应包括具有不对称大小分片的集群。要使用此资源，请求的服务帐户或 API 密钥必须具有“项目只读”角色。此功能不适用于无服务器集群。
此端点还可用于使用 createCluster 端点创建的 Flex 集群或 1 月 2026之前已迁移到 Flex 集群的以前的 M2/M5 集群。请改用 Flex 集群的 listFlexClusters 端点。
此命令是自动生成的，对应 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-listclusters 。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api clusters listClusters [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | listClusters 帮助 | |
--includeCount | false | 标志，用于指示响应是否返回响应中的列项总数 (totalCount)。 | |
--includeDeletedWithRetainedBackups | false | 指示是否返回具有保留备份的集群的标志。 | |
--itemsPerPage | int | 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", "2023-02-01", "2024-08-05"]，默认为最新版本或配置文件 api_version 配置值，如果设立此值默认为 "2024-08-05"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
atlas api clusters listClusters --version 2024-08-05 --groupId [your-project-id]