atlas api clusters updateCluster

Atlas CLI对使用Atlas Administration API运行命令的支持处于预览状态。在预览期间，功能和相应的文档可能随时更改。要学习；了解详情，请参阅预览功能。

实验：更新指定项目中一个集群的详细信息。

集群包含一组维护相同数据集的群组。此资源可以更新具有不对称大小分片的集群。要更新集群的终止保护，请求的API密钥必须具有项目所有者角色。对于所有其他更新，请求的API密钥必须具有“项目集群经理”角色。无法修改已暂停的集群(paused : true)。您必须调用此端点以设立Paused : false。在此端点以 Paused: false 进行响应后，您可以再次调用它以对集群进行更改。此功能不适用于无服务器集群。此命令正在调用 OperationID 为“updateCluster”的端点。有关标志、文件格式和示例的更多信息，请参阅：https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Clusters/operation/updateCluster

语法

命令语法

atlas api clusters updateCluster [options]

选项

名称	类型	必需	说明
--clusterName	字符串	true	用于标识集群的人类可读标签
--envelope		false	标志，指示应用程序是否将响应包装在信封JSON对象中
--file	字符串	false	包含API请求内容的文件的路径
--groupId	字符串	true	用于标识项目的唯一 24-十六进制数字字符串
-h，--help		false	updateCluster 帮助
--output	字符串	false	首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。
--output-file	字符串	false	要将API输出写入其中的文件。当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志
--pretty		false	标志，指示响应正文是否应采用美观打印格式
--version	字符串	false	进行API调用时要使用的API版本 [选项: "2023-01-01", "2023-02-01", "2024-08-05", "2024-10-23"]，默认为最新版本或配置文件 api_version 配置值，如果设立了此值，则默认为 "2024-10-23"。

继承选项

名称	类型	必需	说明
-P, --profile	字符串	false	要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。