更新一个项目中的一个集群

修补 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}
服务账户 DigestAuth

更新指定项目中一个集群的详细信息。集群包含一组维护相同数据集的主机。此资源可以更新具有不对称大小分片的集群。要更新集群的终止保护，请求的服务账户或 API 密钥必须具有项目所有者角色。对于所有其他更新，请求的服务帐户或 API 密钥必须具有“项目集群管理员”角色。您无法修改已暂停的集群（paused : true）。您必须调用此终结点来设置 paused : false。在此终结点使用 paused : false 响应后，您可以再次调用它以对集群进行更改。此功能不适用于无服务器集群。已弃用的版本：v2-{2024-08-05}、v2-{2023-02-01}、v2-{2023-01-01}

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式：^([a-f0-9]{24})$。

  • 集群名称 字符串 必需

    用于标识集群的人类可读标签。

    格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false 。

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false 。

    Prettyprint
application/vnd.atlas.2024-10-23+json

body 必需

指定项目中要更新的集群。

  • acceptDataRisksAndForceReplicaSetReconfig string(date-time)

    如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。 此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    在区域中断期间重新配置副本集
  • 高级配置 对象

    配置高级配置详细信息子集的设置组。

    隐藏高级配置属性 显示高级配置属性 对象
    • customOpensslCipherConfigTls12 array[string]

      TLS 1.2 的自定义 OpenSSL 密码套件列表。 此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

      值为 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 或 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256。

    • minimumEnabledTlsProtocol 字符串

      集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS 协议版本。

      值为 TLS1_0、TLS1_1 或 TLS1_2。

      该选项对应于“netssldisabledProtocols”“mongod”配置文件选项
    • tlsCipherConfigMode 字符串

      TLS 密码套件配置模式。 默认模式使用默认密码套件。 自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

      值为 CUSTOM 或 DEFAULT。

  • backupEnabled 布尔

    指示集群是否可以执行备份的标志。如果设立为true ，则集群可以执行备份。对于true NVMe 集群，必须将此值设立为 。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设立为false ，则集群不使用备份。

    默认值为false 。

    云备份
  • BI Connector 对象

    为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

    MongoDB Connector for Business Intelligence
    隐藏 biConnector 属性 显示双连接器属性 对象
    • enabled 布尔

      指示是否在指定集群上启用MongoDB Connector for Business Intelligence 的标志。

    • readPreference 字符串

      为MongoDB Cloud 上的MongoDB Connector for Business Intelligence 指定的数据源节点。 MongoDB Cloud 上的MongoDB Connector for Business Intelligence 会根据您的读取偏好从主节点 (primary node in the replica set)、从节点(secondary node from replica set)或分析节点读取数据。默认为 ANALYTICS节点，如果没有 ANALYTICS 节点，则为 SECONDARY。

      值为 PRIMARY、SECONDARY 或 ANALYTICS。

      读取BI Connector的偏好
  • clusterType 字符串

    组成该集群的节点的配置。

    值为 REPLICASET、SHARDED 或 GEOSHARDED。

  • configServerManagementMode 字符串

    用于创建或更新分片集群的配置服务器管理模式。

    配置为 ATLAS_MANAGED 时，atlas 可能会自动切换集群的配置服务器类型，以获得最佳性能并节省成本。

    当配置为 FIXED_TO_DEDICATED 时，集群将始终使用专用的配置服务器。

    值为 ATLAS_MANAGED 或 FIXED_TO_DEDICATED。默认值为 ATLAS_MANAGED。

    MongoDB 分片集群配置服务器
  • diskWarmingMode 字符串

    磁盘预热模式选择

    值为 FULLY_WARMED 或 VISIBLE_EARLIER。默认值为 FULLY_WARMED。

    减少从节点磁盘升温的影响
  • encryptionAtRestProvider 字符串

    管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

    取值为 NONE、AWS、AZURE 或 GCP。

    使用客户密钥管理进行静态加密
  • globalClusterSelfManagedSharding 布尔

    设置该字段，用于在创建新的全球集群时配置分片管理模式。

    当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

    当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

    一旦集群部署完毕，此设置就无法更改。

    创建全球集群
  • labels 大量[对象] 已弃用

    长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

    集群标签已弃用，并将在未来发布中删除。我们强烈建议您改用资源标签。

    应用于此MongoDB Cloud 组件的人类可读标签。

    Resource Tags
    隐藏标签属性 显示标签属性 对象
    • key 字符串

      用于标签和分类该组件的键。

      最小长度为 1，最大长度为 255。

    • 值 字符串

      设立为用于标签和分类该组件的键的值。

      最小长度为 1，最大长度为 255。

  • mongoDBEmployeeAccessGrant 对象

    MongoDB 员工被授予集群访问权限级别和过期时间。

    隐藏 mongoDBEmployeeAccessGrant 属性 显示 mongoDBEmployeeAccessGrant 属性 对象
    • expirationTime string(date-time) 必需

      员工访问权限授予的到期日期。 此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • grantType 字符串 必需

      授予 MongoDB 员工的访问权限级别。

      值为 CLUSTER_DATABASE_LOGS、CLUSTER_INFRASTRUCTURE 或 CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA。

  • mongoDBMajorVersion 字符串

    集群的MongoDB主要版本。 设置为二进制主要版本。

    创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本终结点的 API 终结点。

    更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

    Atlas 中可用的 MongoDB 版本
  • 名称 字符串

    用于标识集群的人类可读标签。

    格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。

  • paused 布尔

    指示集群是否已暂停的标志。

  • pitEnabled 布尔

    指示集群是否使用连续云备份的标志。

    持续的云备份
  • redactClientLogData 布尔

    启用或禁用日志校订。

    此设置将 mongod 或 mongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。

    将 redactClientLogData 与静态加密和 TLS/SSL（传输加密）结合使用，以帮助遵守监管要求。

    注意：在集群上更改此设置将在更新集群后立即触发滚动重启。

    日志编辑 (Redaction)
  • replicaSetScalingStrategy 字符串

    设置此字段以配置集群的副本集扩展模式。

    默认情况下，Atlas 在 WORKLOAD_TYPE 下进行扩展。此模式允许 Atlas 将分析节点与操作节点并行扩展。

    当配置为 SEQUENTIAL 时， Atlas 会按顺序扩展所有节点。该模式适用于稳态工作负载和执行对延迟敏感的二次读取的应用程序。

    当配置为 NODE_TYPE 时，Atlas 会将可选举节点与只读节点和分析节点并行扩展。此模式适用于需要频繁和及时的集群层扩展的大型动态工作负载。这是最快的扩展策略，但在执行大量从节点读取时，它可能会影响工作负载的延迟。

    值为 SEQUENTIAL、WORKLOAD_TYPE 或 NODE_TYPE。默认值为 WORKLOAD_TYPE。

    修改副本集扩展模式
  • replicationSpecs 大量[对象]

    用于配置集群区域的设置列表。该数组每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个对象表示节点配置。

    解释MongoDB Cloud 如何在指定MongoDB 数据库上复制数据的详细信息。

    隐藏 replicationSpecs 属性 显示 replicationSpecs 属性 对象
    • regionConfigs 大量[对象]

      为给定地区设立的节点的硬件规格。根据 replicationSpec 中的地区和云提供商的不同，每个 regionConfigs 对象必须是唯一的。每个regionConfigs对象都描述了该区域在选举中的优先级以及MongoDB Cloud 部署到该地区的MongoDB节点的数量和类型。每个regionConfigs对象都必须具有AnalyticsSpecs对象、electableSpecs对象或readOnlySpecs对象。租户集群只需要electableSpecs。专用集群可以指定任何这些规范，但在replicationSpec中必须至少有一个electableSpecs对象。

      示例：

      如果设立"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30" ，请设立"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M 30 " if you have electable nodes and "replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize"：如果有只读节点，则为 "M30"。

      以下之一：
      AWS对象 AZURE对象 GCP对象 TENANT对象
    • zoneName 字符串

      人类可读标签，描述此分片在全球分片中所属的区域。 仅在 "clusterType" : "GEOSHARDED" 而非 "selfManagedSharding" : true 时提供此值。

  • rootCertType 字符串

    MongoDB Atlas 群集使用的根证书颁发机构。MongoDB Cloud 支持 Internet Security Research Group。

    值为 ISRGROOTX1。默认值为 ISRGROOTX1。

  • 标记 大量[对象]

    包含长度介于 1 到 255 个字符之间的键值对的列表，用于对集群进行标记和分类。

    用于标记和分类MongoDB Cloud组织、项目或集群的键值对。示例，environment : production。

    Resource Tags
    Hide tags attributes 显示标签属性 对象
    • key 字符串 必需

      定义标签集的常量。 例如， environment : production标签中的environment 。

      最小长度为 1，最大长度为 255。

    • 值 字符串 必需

      属于该标签集的变量。 例如， environment : production标签中的production 。

      最小长度为 1，最大长度为 255。

  • terminationProtectionEnabled 布尔

    指示是否在集群上启用终止保护的标记。如果设置为 true，MongoDB Cloud 将不会删除集群。如果设置为 false，MongoDB Cloud 将删除集群。

    默认值为false 。

  • versionReleaseSystem 字符串

    集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

    值为 LTS 或 CONTINUOUS。默认值为 LTS。

响应

  • 200 application/vnd.atlas.2024-10-23+json

    正常

    隐藏响应属性 显示响应属性 对象
    • acceptDataRisksAndForceReplicaSetReconfig string(date-time)

      如果由于区域停电而需要重新配置以重新获得主节点，请与拓扑结构重新配置一起提交此字段，以请求新的区域抗停电拓扑。如果复制的写入操作（甚至多数提交的写入操作）尚未复制到新的主节点，则在大多数可选举节点中断期间强制重新配置会带来数据丢失的风险。MongoDB Atlas 文档包含更多信息。要继续执行存在该风险的操作，请将 acceptDataRisksAndForceReplicaSetReconfig 设置为当前日期。 此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      在区域中断期间重新配置副本集
    • 高级配置 对象

      配置高级配置详细信息子集的设置组。

      隐藏高级配置属性 显示高级配置属性 对象
      • customOpensslCipherConfigTls12 array[string]

        TLS 1.2 的自定义 OpenSSL 密码套件列表。 此字段仅在 tlsCipherConfigMode设立为 CUSTOM 时有效。

        值为 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 或 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256。

      • minimumEnabledTlsProtocol 字符串

        集群接受的用于传入连接的最低传输层安全性 (TLS) 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS 协议版本。

        值为 TLS1_0、TLS1_1 或 TLS1_2。

        该选项对应于“netssldisabledProtocols”“mongod”配置文件选项
      • tlsCipherConfigMode 字符串

        TLS 密码套件配置模式。 默认模式使用默认密码套件。 自定义模式允许您为 TLS 1.2 和 TLS 1.3 指定自定义密码套件。

        值为 CUSTOM 或 DEFAULT。

    • backupEnabled 布尔

      指示集群是否可以执行备份的标志。如果设立为true ，则集群可以执行备份。对于true NVMe 集群，必须将此值设立为 。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设立为false ，则集群不使用备份。

      默认值为false 。

      云备份
    • BI Connector 对象

      为此集群配置 MongoDB Connector for Business Intelligence 所需的设置。

      MongoDB Connector for Business Intelligence
      隐藏 biConnector 属性 显示双连接器属性 对象
      • enabled 布尔

        指示是否在指定集群上启用MongoDB Connector for Business Intelligence 的标志。

      • readPreference 字符串

        为MongoDB Cloud 上的MongoDB Connector for Business Intelligence 指定的数据源节点。 MongoDB Cloud 上的MongoDB Connector for Business Intelligence 会根据您的读取偏好从主节点 (primary node in the replica set)、从节点(secondary node from replica set)或分析节点读取数据。默认为 ANALYTICS节点，如果没有 ANALYTICS 节点，则为 SECONDARY。

        值为 PRIMARY、SECONDARY 或 ANALYTICS。

        读取BI Connector的偏好
    • clusterType 字符串

      组成该集群的节点的配置。

      值为 REPLICASET、SHARDED 或 GEOSHARDED。

    • configServerManagementMode 字符串

      用于创建或更新分片集群的配置服务器管理模式。

      配置为 ATLAS_MANAGED 时，atlas 可能会自动切换集群的配置服务器类型，以获得最佳性能并节省成本。

      当配置为 FIXED_TO_DEDICATED 时，集群将始终使用专用的配置服务器。

      值为 ATLAS_MANAGED 或 FIXED_TO_DEDICATED。默认值为 ATLAS_MANAGED。

      MongoDB 分片集群配置服务器
    • configServerType 字符串

      描述分片集群的配置服务器类型。

      值为 DEDICATED 或 EMBEDDED。

      MongoDB 分片集群配置服务器
    • 连接字符串(Connection Strings) 对象

      指向 MongoDB 数据库的统一资源定位符集合。

      连接字符串 URI 格式
      隐藏 connectionStrings 属性 显示 connectionStrings 属性 对象
      • awsPrivateLink 对象

        将 AWS 托管集群与Amazon Web Services (AWS) PrivateLink 结合使用的私有端点感知连接字符串。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串，用于通过键指定的接口端点连接到MongoDB Cloud。

        网络对等连接
        隐藏 awsPrivateLink 属性 显示 awsPrivateLink 属性 对象
        • * 字符串 additionalProperties

          将 AWS 托管集群与Amazon Web Services (AWS) PrivateLink 结合使用的私有端点感知连接字符串。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串，用于通过键指定的接口端点连接到MongoDB Cloud。

          网络对等连接
      • awsPrivateLinkSrv 对象

        将 AWS 托管集群与Amazon Web Services (AWS) PrivateLink 结合使用的私有端点感知连接字符串。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串，用于通过键指定的接口端点连接到Atlas 。如果集群使用优化的连接字符串，则 awsPrivateLinkSrv 包含优化的连接字符串。如果集群具有非优化（传统）连接字符串，则即使也存在优化连接字符串，awsPrivateLinkSrv 也包含非优化连接字符串。

        网络对等连接
        隐藏 awsPrivateLinkSrv 属性 显示 awsPrivateLinkSrv 属性 对象
        • * 字符串 additionalProperties

          将 AWS 托管集群与Amazon Web Services (AWS) PrivateLink 结合使用的私有端点感知连接字符串。每个密钥标识一个Amazon Web Services (AWS)接口端点。每个值都标识相关的 mongodb://连接字符串，用于通过键指定的接口端点连接到Atlas 。如果集群使用优化的连接字符串，则 awsPrivateLinkSrv 包含优化的连接字符串。如果集群具有非优化（传统）连接字符串，则即使也存在优化连接字符串，awsPrivateLinkSrv 也包含非优化连接字符串。

          网络对等连接
      • private 字符串

        您配置为连接到此集群的每个接口虚拟私有云 ( VPC ) 端点的网络对等互连字符串。该连接字符串使用 mongodb+srv://协议。一旦有人创建与此集群的网络对等连接，资源就会返回此参数。该协议指示应用程序在域名系统 (DNS) 中查找托管种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符 (URI) 格式，则在节点发生变化时，您无需附加种子列表或更改 URI。如果您的驾驶员支持，请使用此 URI 格式。如果没有，请使用 connectionStrings.private。对于Amazon Web Services (AWS) 集群，仅当启用自定义 DNS 时，此资源才会返回此参数。

        网络对等连接
      • privateEndpoint 大量[对象]

        可用于通过私有端点连接到此集群的私有端点感知连接字符串列表。仅当您将私有端点部署到部署此集群节点的所有区域时，此参数才会返回。

        私有端点感知连接字符串，可用于通过私有端点连接到此集群。

        隐藏 privateEndpoint 属性 显示 privateEndpoint 属性 对象
        • ConnectionString 字符串

          私有端点感知连接字符串，使用 mongodb://协议通过私有端点连接到MongoDB Cloud。

        • 端点 大量[对象]

          包含私有端点的列表，当您使用 connectionStrings.privateEndpoint[n].connectionString 或 connectionStrings.privateEndpoint[n].srvConnectionString 时，您通过这些端点连接到MongoDB Cloud。

          为此集群部署的私有端点的详细信息。

          隐藏端点属性 显示端点属性 对象
          • endpointId 字符串

            云提供商用于标识私有端点的唯一字符串。

          • 提供商名称 字符串

            MongoDB Cloud 在其中部署私有端点的云提供商。

            值为 AWS、AZURE 或 GCP。

          • 区域 字符串

            部署私有端点的区域。

        • srvConnectionString 字符串

          私有端点感知连接字符串，使用 mongodb+srv://协议通过私有端点连接到MongoDB Cloud。 mongodb+srv协议指示驾驶员在域名系统 (DNS) 中查找主机的种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符 (URI) 格式，则在节点发生变化时，您无需附加种子列表或更改统一资源标识符 (URI)。如果应用程序支持，请使用此统一资源标识符 (URI) 格式。如果没有，请使用 connectionStrings.privateEndpoint[n].connectionString。

        • srvShardOptimizedConnectionString 字符串

          针对分片的片集群优化的私有端点感知连接字符串，使用 mongodb+srv://协议通过私有端点连接到MongoDB Cloud。如果连接字符串使用此统一资源标识符 (URI) 格式，则在节点发生变化时，您无需更改统一资源标识符 (URI)。如果您的应用程序和Atlas 集群支持，请使用此统一资源标识符 (URI) 格式。如果没有，请使用并查阅 connectionStrings.privateEndpoint[n].srvConnectionString 的文档。

        • 类型 字符串

          应用程序连接的MongoDB进程类型。将 MONGOD 用于副本集，将 MONGOS 用于分片的集群。

          值为 MONGOD 或 MONGOS。

      • privateSrv 字符串

        您配置为连接到此集群的每个接口虚拟私有云 ( VPC ) 端点的网络对等互连字符串。该连接字符串使用mongodb+srv:// 协议。当有人创建与此集群的网络对等连接时，资源会返回此参数。该协议指示应用程序在域名系统 (DNS) 中查找托管种子列表。此列表与集群中的节点同步。如果连接字符串使用此统一资源标识符 (URI) 格式，则在节点发生变化时，您无需附加种子列表或更改统一资源标识符 (URI)。如果您的驾驶员支持，请使用此统一资源标识符 (URI) 格式。如果没有，请使用connectionStrings.private 。对于Amazon Web Services (AWS) 集群，仅当启用custom DNS 时，此参数才会返回。

        网络对等连接
      • 标准 字符串

        可用于连接到此集群的公共连接字符串。该连接字符串使用 mongodb://协议。

        连接字符串 URI 格式
      • standardSrv 字符串

        可用于连接到此集群的公共连接字符串。该连接字符串使用 mongodb+srv://协议。

        连接字符串 URI 格式
    • createdate string(date-time)

      MongoDB Cloud 创建此集群的日期和时间。此参数以 UTC 的 ISO 8601 格式表示其值。

    • diskWarmingMode 字符串

      磁盘预热模式选择

      值为 FULLY_WARMED 或 VISIBLE_EARLIER。默认值为 FULLY_WARMED。

      减少从节点磁盘升温的影响
    • encryptionAtRestProvider 字符串

      管理客户密钥的云服务提供商，为集群提供额外的静态加密层。要为静态加密启用客户密钥管理，集群的 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 设置必须为 M10 或更高，且 "backupEnabled" : false 或完全省略。

      取值为 NONE、AWS、AZURE 或 GCP。

      使用客户密钥管理进行静态加密
    • 特征兼容性版本 字符串

      集群的特征兼容性版本。无论FCV是否固定，它都会始终出现。

    • featureCompatibilityVersionExpirationDate string(date-time)

      功能兼容性版本到期日期。仅在 FCV 被固定时才会显示。 此参数以 UTC 格式的 ISO 8601 时间戳格式表示其值。

    • globalClusterSelfManagedSharding 布尔

      设置该字段，用于在创建新的全球集群时配置分片管理模式。

      当设置为 false 时，管理模式设置为 Atlas-托管分片。此模式可全面托管全球集群的分片，旨在提供无缝部署体验。

      当设置为真时，管理模式设置为自我托管分片。此模式将分片的管理权交给您，旨在提供先进、灵活的部署体验。

      一旦集群部署完毕，此设置就无法更改。

      创建全球集群
    • groupId 字符串

      唯一的 24 位十六进制字符串，用于标识项目。

      格式应符合以下模式：^([a-f0-9]{24})$。

    • id 字符串

      唯一的 24 位十六进制数字字符串，用于标识集群。

      格式应符合以下模式：^([a-f0-9]{24})$。

    • labels 大量[对象] 已弃用

      长度在 1 到 255 个字符之间的键值对集合，用于标记和分类集群。MongoDB Cloud 控制台不显示您的标签。

      集群标签已弃用，并将在未来发布中删除。我们强烈建议您改用资源标签。

      应用于此MongoDB Cloud 组件的人类可读标签。

      Resource Tags
      隐藏标签属性 显示标签属性 对象
      • key 字符串

        用于标签和分类该组件的键。

        最小长度为 1，最大长度为 255。

      • 值 字符串

        设立为用于标签和分类该组件的键的值。

        最小长度为 1，最大长度为 255。

    • 链接 大量[对象]

      点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

      Web 链接规范 (RFC 5988)
      隐藏链接属性 显示链接属性 对象
      • href 字符串

        统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

      • rel 字符串

        统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • mongoDBEmployeeAccessGrant 对象

      MongoDB 员工被授予集群访问权限级别和过期时间。

      隐藏 mongoDBEmployeeAccessGrant 属性 显示 mongoDBEmployeeAccessGrant 属性 对象
      • expirationTime string(date-time) 必需

        员工访问权限授予的到期日期。 此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • grantType 字符串 必需

        授予 MongoDB 员工的访问权限级别。

        值为 CLUSTER_DATABASE_LOGS、CLUSTER_INFRASTRUCTURE 或 CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA。

      • 链接 大量[对象]

        点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

        Web 链接规范 (RFC 5988)
        隐藏链接属性 显示链接属性 对象
        • href 字符串

          统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

        • rel 字符串

          统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • mongoDBMajorVersion 字符串

      集群的MongoDB主要版本。 设置为二进制主要版本。

      创建时：从 MongoDB 的可用版本中进行选择，或者在 MongoDB Cloud 平台上，对当前建议的默认值保持不作指定。推荐的版本是最新的长期支持版本。在整个发布周期中，默认值并不保证是最新发布的版本。有关特定项目中可用的版本，请参阅链接的文档或使用项目 LTS 版本终结点的 API 终结点。

      更新时：一次只能增加 1 个主要版本的版本。 如果将集群固定到比当前 MongoDB 版本低一个主要版本的 MongoDB 功能兼容版本，则 MongoDB 版本可以降级到上一个主要版本。

      Atlas 中可用的 MongoDB 版本
    • MongoDB 版本 字符串

      集群运行的 MongoDB 版本。

      格式应符合以下模式：([\d]+\.[\d]+\.[\d]+)。

    • 名称 字符串

      用于标识集群的人类可读标签。

      格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。

    • paused 布尔

      指示集群是否已暂停的标志。

    • pitEnabled 布尔

      指示集群是否使用连续云备份的标志。

      持续的云备份
    • redactClientLogData 布尔

      启用或禁用日志校订。

      此设置将 mongod 或 mongos 配置为在登录之前编辑与给定日志事件相关的消息中的任何文档字段内容。这可以防止程序将存储在数据库上的潜在敏感数据写入诊断日志。错误或操作代码、行号和源文件名等元数据在日志中仍然可见。

      将 redactClientLogData 与静态加密和 TLS/SSL（传输加密）结合使用，以帮助遵守监管要求。

      注意：在集群上更改此设置将在更新集群后立即触发滚动重启。

      日志编辑 (Redaction)
    • replicaSetScalingStrategy 字符串

      设置此字段以配置集群的副本集扩展模式。

      默认情况下，Atlas 在 WORKLOAD_TYPE 下进行扩展。此模式允许 Atlas 将分析节点与操作节点并行扩展。

      当配置为 SEQUENTIAL 时， Atlas 会按顺序扩展所有节点。该模式适用于稳态工作负载和执行对延迟敏感的二次读取的应用程序。

      当配置为 NODE_TYPE 时，Atlas 会将可选举节点与只读节点和分析节点并行扩展。此模式适用于需要频繁和及时的集群层扩展的大型动态工作负载。这是最快的扩展策略，但在执行大量从节点读取时，它可能会影响工作负载的延迟。

      值为 SEQUENTIAL、WORKLOAD_TYPE 或 NODE_TYPE。默认值为 WORKLOAD_TYPE。

      修改副本集扩展模式
    • replicationSpecs 大量[对象]

      用于配置集群区域的设置列表。该数组每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个对象表示节点配置。

      解释MongoDB Cloud 如何在指定MongoDB 数据库上复制数据的详细信息。

      隐藏 replicationSpecs 属性 显示 replicationSpecs 属性 对象
      • id 字符串

        唯一的 24-十六进制数字字符串，用于标识集群分片的复制对象。如果在请求中包含现有的分片复制配置，则必须指定此参数。如果向现有集群添加新分片，则可以指定此参数。该请求会删除您从请求中排除的集群中的任何现有分片。这与用户界面中显示的分片ID相对应。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • regionConfigs 大量[对象]

        为给定地区设立的节点的硬件规格。根据 replicationSpec 中的地区和云提供商的不同，每个 regionConfigs 对象必须是唯一的。每个regionConfigs对象都描述了该区域在选举中的优先级以及MongoDB Cloud 部署到该地区的MongoDB节点的数量和类型。每个regionConfigs对象都必须具有AnalyticsSpecs对象、electableSpecs对象或readOnlySpecs对象。租户集群只需要electableSpecs。专用集群可以指定任何这些规范，但在replicationSpec中必须至少有一个electableSpecs对象。

        示例：

        如果设立"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30" ，请设立"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M 30 " if you have electable nodes and "replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize"：如果有只读节点，则为 "M30"。

        以下之一：
        AWS对象 AZURE对象 GCP对象 TENANT对象
      • zoneId 字符串

        唯一的 24-十六进制数字字符串，用于标识全局集群中的区域。此值可用于配置全局集群备份策略。

        格式应符合以下模式：^([a-f0-9]{24})$。

      • zoneName 字符串

        人类可读标签，描述此分片在全球分片中所属的区域。 仅在 "clusterType" : "GEOSHARDED" 而非 "selfManagedSharding" : true 时提供此值。

    • rootCertType 字符串

      MongoDB Atlas 群集使用的根证书颁发机构。MongoDB Cloud 支持 Internet Security Research Group。

      值为 ISRGROOTX1。默认值为 ISRGROOTX1。

    • stateName 字符串

      人类可读标签，指示Atlas控制平面在此集群上进行的任何当前活动。除 CREATING 和 DELETING 状态外，即使处于指示正在进行活动的状态，集群也应始终可用并具有主节点。

      • IDLE： Atlas没有对此集群进行任何更改，并且可以假定通过用户界面或API请求的所有更改都已应用。
      • CREATING：首次预配的集群会返回 CREATING 状态，直到准备好连接为止。在尝试连接之前，确保已配置IP访问列表和数据库用户。
      • UPDATING：正在执行通过用户界面、 API、 AutoScaling 或其他计划活动请求的更改。
      • DELETING：集群正在删除进程，即将被删除。
      • REPAIRING： Atlas控制平面正在使集群中的一个或多个节点恢复服务。其他节点应继续正常提供服务。

      取值为 IDLE、CREATING、UPDATING、DELETING 或 REPAIRING。

    • 标记 大量[对象]

      包含长度介于 1 到 255 个字符之间的键值对的列表，用于对集群进行标记和分类。

      用于标记和分类MongoDB Cloud组织、项目或集群的键值对。示例，environment : production。

      Resource Tags
      Hide tags attributes 显示标签属性 对象
      • key 字符串 必需

        定义标签集的常量。 例如， environment : production标签中的environment 。

        最小长度为 1，最大长度为 255。

      • 值 字符串 必需

        属于该标签集的变量。 例如， environment : production标签中的production 。

        最小长度为 1，最大长度为 255。

    • terminationProtectionEnabled 布尔

      指示是否在集群上启用终止保护的标记。如果设置为 true，MongoDB Cloud 将不会删除集群。如果设置为 false，MongoDB Cloud 将删除集群。

      默认值为false 。

    • versionReleaseSystem 字符串

      集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

      值为 LTS 或 CONTINUOUS。默认值为 LTS。
  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 409 application/json

    冲突。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。
PATCH /API/Atlas/v2/groups/{groupId}/clusters/{clusterName} 
atlas api clusters updateGroupCluster --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdateGroupClusterApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		UpdateGroupClusterWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
  -d '{ <Payload> }'
请求示例 
{
  "acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "backupEnabled": false,
  "biConnector": {
    "enabled": true,
    "readPreference": "PRIMARY"
  },
  "clusterType": "REPLICASET",
  "configServerManagementMode": "ATLAS_MANAGED",
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "globalClusterSelfManagedSharding": true,
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "mongoDBEmployeeAccessGrant": {
    "expirationTime": "2025-05-04T09:42:00Z",
    "grantType": "CLUSTER_DATABASE_LOGS"
  },
  "mongoDBMajorVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "redactClientLogData": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 42.0,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "diskSizeGB": 42.0,
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "diskSizeGB": 42.0,
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
响应示例 (200) 
{
  "acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "backupEnabled": false,
  "biConnector": {
    "enabled": true,
    "readPreference": "PRIMARY"
  },
  "clusterType": "REPLICASET",
  "configServerManagementMode": "ATLAS_MANAGED",
  "configServerType": "DEDICATED",
  "connectionStrings": {
    "awsPrivateLink": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "awsPrivateLinkSrv": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "private": "string",
    "privateEndpoint": [
      {
        "connectionString": "string",
        "endpoints": [
          {
            "endpointId": "string",
            "providerName": "AWS",
            "region": "string"
          }
        ],
        "srvConnectionString": "string",
        "srvShardOptimizedConnectionString": "string",
        "type": "MONGOD"
      }
    ],
    "privateSrv": "string",
    "standard": "string",
    "standardSrv": "string"
  },
  "createDate": "2025-05-04T09:42:00Z",
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "featureCompatibilityVersion": "string",
  "featureCompatibilityVersionExpirationDate": "2025-05-04T09:42:00Z",
  "globalClusterSelfManagedSharding": true,
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mongoDBEmployeeAccessGrant": {
    "expirationTime": "2025-05-04T09:42:00Z",
    "grantType": "CLUSTER_DATABASE_LOGS",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "mongoDBMajorVersion": "string",
  "mongoDBVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "redactClientLogData": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 42.0,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "diskSizeGB": 42.0,
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "diskSizeGB": 42.0,
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneId": "32b6e34b3d91647abb20e7b8",
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
响应示例 (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
响应示例 (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
响应示例 (409) 
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
响应示例 (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}