将一个本地托管集群迁移到 MongoDB Atlas 已弃用

发布 /api/atlas/v2/groups/{groupId}/liveMigrations

将 Cloud 或 Ops Manager 托管的一个集群迁移到 MongoDB Atlas。

请确保在开始迁移之前进行验证。

您只能将此 API 端点用于推送实时迁移。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

注意:MongoDB 6.0 或更高版本尚不支持迁移时间序列集合。MongoDB 6.0 或更高版本上的迁移将跳过源集群上的任何时间序列集合。

验证迁移

路径参数

  • groupId 字符串 必需

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

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

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

查询参数

  • envelope 布尔

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

    默认值为false

  • pretty 布尔

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

    默认值为false

    Prettyprint
application/vnd.atlas.2023-01-01+json

body 必需

要创建的一个迁移。

  • 目的地 对象 必需

    描述迁移目标的文档。

    隐藏目标属性 显示目标属性 对象
    • 集群名称 字符串 必需

      标识目标集群的标签。

      最小长度为 1

    • groupId 字符串 必需

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

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

    • hostnameSchemaType 字符串 必需

      迁移主机和目标集群之间使用的网络类型。

      最小长度为 1。值为 PUBLICPRIVATE_LINKVPC_PEERING

    • privateLinkId 字符串

      表示托管模式类型为 PRIVATE_LINK 时要使用的端点。

  • dropEnabled 布尔 必需

    指示迁移过程是否在迁移开始之前从目标集群删除所有集合的标志。

  • migrationHosts array[string]

    用于此迁移的迁移主机列表。

    至少 1 个但不超过 1 个元素。

  • 分片 对象

    当从副本集源迁移到 MongoDB 6.0 或更高版本上的分片集群目标时,在目标集群上配置分片的文档。如果您不希望对目标集群上的任何集合进行分片,请将其留空。

    隐藏分片属性 显示分片属性 对象
    • createSupportingIndexes 布尔 必需

      标志,允许迁移为分片键创建支持索引(如果不存在),因为目标集群也需要指定分片键的兼容索引。

    • shardingEntries 大量[对象]

      用于对分片集合进行分片的分片配置列表。 Atlas仅对您包含在分片条目大量中的那些集合进行分片。

      要在目标集群上分片的集合的分片配置。

      隐藏 shardingEntries 属性 显示 shardingEntries 属性 对象
      • 集合 字符串 必需

        人类可读标签,用于标识要在目标集群上分片的集合。

      • database 字符串 必需

        人类可读标签,用于标识包含要在目标集群上分片的的集合的数据库。

      • shardCollection 对象 必需

        在目标集群上配置分片键的文档。

        隐藏 shardCollection 属性 显示 shardCollection 属性 对象
        • key 大量[对象]

          用于分片键的字段列表。

          隐藏键属性 显示键属性 对象
          • * 对象 additionalProperties
  • 来源 对象 必需

    描述迁移来源的文档。

    隐藏源属性 显示源属性 对象
    • caCertificatePath 字符串

      签名 SSL 证书用于对源集群进行身份验证的 CA 证书的路径。

    • 集群名称 字符串 必需

      标识源集群名称的标签。

      最小长度为 1

    • groupId 字符串 必需

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

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

    • ManagedAuthentication 布尔 必需

      指示MongoDB自动化是否管理对源集群的身份验证的标志。如果为 true,则不提供用户名和密码的值。

    • 密码 字符串

      用于在源集群中验证用户名的密码。

    • ssl 布尔 必需

      指示是否已启用 SSL 的标志。

    • 用户名 字符串

      标识连接到源集群的SCRAM -SHA 用户的标签。

响应

  • 201 application/vnd.atlas.2023-01-01+json

    已创建

    隐藏响应属性 显示响应属性 对象
    • _id 字符串

      标识迁移作业的唯一 24-十六进制数字字符串。

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

    • lagTimeSeconds 整数 (int64) | null

      源集群和目标集群之间的复制延迟。 Atlas仅在切换阶段之前的活动迁移期间返回此设置。

    • migrationHosts array[string]

      运行MongoDB助手的主机列表。这些代理可以在一个源集群和一个目标集群之间传输MongoDB数据。

      每个的格式应符合以下模式:^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$

    • ReadyForCutover 布尔

      指示迁移的集群可以切换到MongoDB Atlas 的标志。

    • 状态 字符串

      将一个集群迁移到MongoDB Atlas所取得的进展。

      NEW:有人计划将本地集群迁移到MongoDB Atlas。

      FAILED:集群迁移到MongoDB Atlas失败。

      COMPLETE:已成功将集群迁移到MongoDB Atlas 。

      EXPIRED:当源集群和目标集群几乎同步时, MongoDB Atlas准备开始迁移集群的切换。如果为 "readyForCutover" : true,则此同步将启动 120 小时的计时器。您可以延长此计时器。如果计时器过期, MongoDB Atlas将返回此状态。

      WORKING:到MongoDB Atlas 的集群迁移正在执行以下任务之一:

      • 准备与源集群和目标集群的连接。
      • 将数据从源复制到目标。
      • 验证MongoDB Atlas连接设置。
      • 切换后停止复制。

      取值为 NEWWORKINGFAILEDCOMPLETEEXPIRED

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 500 application/json

    内部服务器错误。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

POST /api/atlas/v2 /groups/{groupId}/liveMigrations
atlas api cloudMigrationService createGroupLiveMigration --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/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.CreateGroupLiveMigrationApiParams{}
	sdkResp, httpResp, err := client.CloudMigrationServiceApi.
		CreateGroupLiveMigrationWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \
  -d '{ <Payload> }'
请求示例
{
  "destination": {
    "clusterName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8",
    "hostnameSchemaType": "PUBLIC",
    "privateLinkId": "string"
  },
  "dropEnabled": true,
  "migrationHosts": [
    "vm001.example.com"
  ],
  "sharding": {
    "createSupportingIndexes": true,
    "shardingEntries": [
      {
        "collection": "string",
        "database": "string",
        "shardCollection": {
          "key": [
            {
              "additionalProperty1": {},
              "additionalProperty2": {}
            }
          ]
        }
      }
    ]
  },
  "source": {
    "caCertificatePath": "string",
    "clusterName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8",
    "managedAuthentication": true,
    "password": "string",
    "ssl": true,
    "username": "string"
  }
}
响应示例 (201)
{
  "_id": "32b6e34b3d91647abb20e7b8",
  "lagTimeSeconds": 42,
  "migrationHosts": [
    "vm001.example.com"
  ],
  "readyForCutover": true,
  "status": "NEW"
}
响应示例 (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"
}
响应示例 (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"
}