- 此版本的文档已存档，不再提供支持。 查看最新文档，学习；了解如何升级Atlas CLI版本。
实验：从指定项目中删除一个集群。
必须禁用终止保护才能删除集群。要使用此资源，请求的API密钥必须具有“项目所有者”角色。此功能不适用于无服务器集群。此端点还可用于使用 createCluster 端点创建的 Flex 集群或 1 月 2026之前已迁移到 Flex 集群的以前的 M2/M5 集群。请改用 Flex 集群的 deleteFlexCluster 端点。此命令调用 OperationID 为“deleteCluster”的端点。有关标志、文件格式和示例的更多信息，请参阅：https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Clusters/operation/deleteCluster
语法
atlas api clusters deleteCluster [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 用于标识集群的人类可读标签 |
--envelope | false | 标志，指示应用程序是否将响应包装在信封JSON对象中 | |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h，--help | false | deleteCluster 帮助 | |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 标志，指示响应正文是否应采用美观打印格式 | |
--retainBackups | false | 标志，指示是否为已删除的专用集群保留备份快照 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"、"2023-02-01"]，默认为最新版本或配置文件 api_version配置值，如果设立此值，则默认为 "2023-02-01"。 |
-w, --watch | false | 该标志指示是否监视命令，直到命令完成执行或监视超时。 | |
--watchTimeout | int | false | 手表超时之前的时间（以秒为单位）。 监视超时后，CLI 将不再监视该命令。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |