验证一个迁移请求

发布 /api/atlas/v1.0/groups/{groupId}/liveMigrations/validate

服务账户 DigestAuth

验证提供的凭据、可用磁盘空间、MongoDB 版本等是否满足迁移请求的要求。如果检查通过，则可以继续迁移。您的 API 密钥必须具有“组织所有者”角色才能成功调用此资源。

路径参数

groupId 字符串必需

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

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

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

查询参数

envelope 布尔

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

默认值为false 。
pretty 布尔

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

默认值为false 。

Prettyprint

application/json

body 必需

有待验证的一次迁移。

目的地对象必需

描述迁移目标的文档。
隐藏目标属性显示目标属性对象
- 集群名称字符串必需
  
  标识目标集群的标签。
  
  最小长度为 1。
- groupId 字符串必需
  
  唯一的 24-十六进制数字字符串，用于标识目标项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- hostnameSchemaType 字符串必需
  
  迁移主机和目标集群之间使用的网络类型。
  
  最小长度为 1。值为 PUBLIC、PRIVATE_LINK 或 VPC_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 用户的标签。

响应

200 application/json

正常
隐藏响应属性显示响应属性对象
- _id 字符串
  
  验证验证的唯一 24-十六进制数字字符串。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- 错误消息字符串 | null
  
  验证作业失败的原因。
- groupId 字符串
  
  唯一的 24-十六进制数字字符串，用于标识要验证的项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- sourceGroupId 字符串
  
  唯一的 24 位十六进制数字字符串，用于标识源项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- 状态字符串 | null
  
  请求时返回的指定验证作业的状态。
  
  值为 PENDING、SUCCESS 或 FAILED。
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/v1.0/groups/{groupId}/liveMigrations/validate

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/liveMigrations/validate' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"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"}}'

请求示例

{
  "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"
  }
}

响应示例 (200)

{
  "_id": "32b6e34b3d91647abb20e7b8",
  "errorMessage": "string",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  "status": "PENDING"
}

响应示例 (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"
}