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

修补 /api/atlas/v2/groups/{groupId}/flexClusters/{name}

更新指定项目中的一个弹性集群。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目所有者”角色。

路径参数

  • groupId 字符串 必需

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

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

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

  • 名称 字符串 必需

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

    格式应符合以下模式:^[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-11-13+json

body 必需

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

  • 标记 大量[对象]

    包含长度介于 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

响应

  • 200 application/vnd.atlas.2024-11-13+json

    正常

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

      Flex备份配置。

      隐藏 backupSettings 属性 显示 backupSettings 属性 对象
      • enabled 布尔

        指示是否为此弹性集群执行备份的标志。备份使用弹性集群备份。

        默认值为true

        Flex 集群备份
    • clusterType 字符串

      Flex集群拓扑结构。

      值为 REPLICASET。默认值为 REPLICASET

    • 连接字符串(Connection Strings) 对象

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

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

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

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

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

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

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

    • groupId 字符串

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

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

    • id 字符串

      标识该实例的唯一 24-十六进制数字字符串。

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

    • MongoDB 版本 字符串

      实例运行的MongoDB版本。

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

    • 名称 字符串

      用于标识实例的人类可读标签。

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

    • providerSettings 对象 必需

      配置预配的 MongoDB 弹性集群的云提供商设置群组。

      隐藏 providerSettings 属性 显示 providerSettings 属性 对象
      • backingProviderName 字符串

        MongoDB Cloud 在其上预配了 Flex集群的云服务提供商。

        值为 AWSAZUREGCP

      • diskSizeGB number(double)

        Flex集群的可用存储容量(以 GB 为单位)。

      • 提供商名称 字符串

        标识提供提供商类型的人类可读标签。

        值为 FLEX。默认值为 FLEX

      • regionName 字符串

        人类可读标签,用于标识MongoDB Flex集群的位置。您选择的地区可能会影响客户端访问数据库的网络延迟。有关地区名称的完整列表,请参阅 AWS GCP和Azure

    • stateName 字符串

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

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

      取值为 IDLECREATINGUPDATINGDELETINGREPAIRING

    • 标记 大量[对象]

      包含长度介于 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版本的方法。

      值为 LTS。默认值为 LTS

  • 400 application/json

    错误请求。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 401 application/json

    未经授权。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 402 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 状态代码。

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

      随此错误返回的应用程序错误消息。

PATCH /api/atlas/v2/groups/{groupId}/flexClusters/{name}
atlas api flexClusters updateGroupFlexCluster --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/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.UpdateGroupFlexClusterApiParams{}
	sdkResp, httpResp, err := client.FlexClustersApi.
		UpdateGroupFlexClusterWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters/{name}" \
  -d '{ <Payload> }'
请求示例
{
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false
}
响应示例 (200)
{
  "backupSettings": {
    "enabled": true
  },
  "clusterType": "REPLICASET",
  "connectionStrings": {
    "standard": "string",
    "standardSrv": "string"
  },
  "createDate": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mongoDBVersion": "string",
  "name": "string",
  "providerSettings": {
    "backingProviderName": "AWS",
    "diskSizeGB": 42.0,
    "providerName": "FLEX",
    "regionName": "string"
  },
  "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"
}
响应示例 (402)
{
  "error": 402,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Payment Required",
  "errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}
响应示例 (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"
}