atlas api clusters updateCluster

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

集群包含一组维护相同数据集的群组。此资源可以更新具有不对称大小分片的集群。要更新集群的终止保护，请求的API密钥必须具有项目所有者角色。对于所有其他更新，请求的API密钥必须具有“项目集群经理”角色。无法修改已暂停的集群(paused : true)。您必须调用此端点以设立Paused : false。在此端点以 Paused: false 进行响应后，您可以再次调用它以对集群进行更改。此功能不适用于无服务器集群。

此命令是自动生成的，对应 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/# 标签/Clusters/ operation/updateCluster。

有关更多信息和示例，请参阅上面链接的参考API文档。

语法

命令语法

atlas api clusters updateCluster [options]

选项

名称	类型	必需	说明
--clusterName	字符串	true	用于标识集群的人类可读标签。
--envelope	envelope	false	指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。
--file	字符串	false	API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。
--groupId	字符串	true	用于标识项目的唯一 24-十六进制数字字符串。使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
-h，--help		false	updateCluster 帮助
--output	字符串	false	首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。
--output-file	字符串	false	要将API输出写入其中的文件。当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志
--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", "2023-02-01", "2024-08-05", "2024-10-23"]，默认为最新版本或配置文件 api_version 配置值，如果设立了此值，则默认为 "2024-10-23"。
-w, --watch		false	该标志指示是否监视命令，直到命令完成执行或监视超时。
--watchTimeout	int	false	手表超时之前的时间（以秒为单位）。监视超时后，CLI 将不再监视该命令。

继承选项

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

示例

更新集群，将磁盘大小增加到 20 GB ，并将节点点数增加到 5

创建以下文件并将其另存为 payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "priority": 7,
          "providerName": "AWS",
          "regionName": "US_EAST_1"
        }
      ]
    }
  ]
}

创建 payload.json 后，在同一目录中运行以下命令。

atlas api clusters updateCluster --version 2024-10-23 --file payload.json --clusterName [your-cluster-name] --envelope false --groupId [your-project-id] --pretty false