为一个 M2 或 M5 集群创建一个恢复作业 | （已弃用） Atlas Admin API v1 文档

为一个 M2 或 M5 集群创建一个恢复作业已弃用

发布 /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore

恢复指定的 M2 或 M5 集群。MongoDB Cloud 限制哪些集群可以作为恢复的目标集群。目标集群无法使用静态加密、运行与快照不同的主要版本 MongoDB 版本或在恢复期间接收客户端请求。MongoDB Cloud 会在恢复操作之前删除目标集群上的所有现有数据。要使用此资源，请求的服务账户或 API 密钥必须具有“项目所有者”角色。

在之前，此端点还可用于使用 createCluster 端点创建的 Flex 集群或已迁移到2 5Flex 集群的前 M /M2026 集群，在此之后此端点将被停用。请改用 createFlexBackupRestoreJob 端点。

创建FlexBackupRestoreJob

路径参数

集群名称字符串必需

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

格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。
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 必需

恢复作业详细信息。

snapshotId 字符串必需

唯一的 24 位十六进制数字字符串，用于标识要恢复的快照。

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

人类可读标签，用于标识要将快照恢复到的目标项目上的集群。您可以将快照恢复到集群层 M2 或更高层。

格式应符合以下模式：^[\p{L}\p{N}\-_.(),:&@+']{1,64}$。
targetProjectId 字符串

唯一的 24 位十六进制数字字符串，用于标识包含要将快照恢复到的集群的项目。

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

响应

200 application/json

正常
隐藏响应属性显示响应属性对象
- 集群名称字符串
  
  用于标识源集群的人类可读标签。
  
  格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。
- deliveryType 字符串
  
  此资源将快照返回给请求的MongoDB Cloud 用户的方式。
  
  值为 RESTORE 或 DOWNLOAD。
- 到期日期 string(date-time)
  
  下载链接失效的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。
- id 字符串
  
  唯一的 24 位十六进制数字字符串，用于标识该恢复作业。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- 链接大量[对象]
  
  点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 开头。
- projectId 字符串
  
  唯一的 24-十六进制数字字符串，用于标识恢复作业所源自的项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- restoreFinishedDate string(date-time)
  
  MongoDB Cloud 完成写入此快照的日期和时间。 MongoDB Cloud 将恢复作业的状态更改为 CLOSED。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。
- restoreScheduledDate string(date-time)
  
  MongoDB Cloud恢复此快照的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。
- snapshotFinishedDate string(date-time)
  
  MongoDB Cloud 完成写入此快照的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。
- snapshotId 字符串必需
  
  唯一的 24 位十六进制数字字符串，用于标识要恢复的快照。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- snapshotUrl 字符串
  
  可下载压缩快照文件的互联网解决。当 "deliveryType" : "DOWNLOAD" 时，资源返回此参数。
- 状态字符串
  
  此资源发出此请求时此作业的恢复工作流程的阶段。
  
  取值为 PENDING、QUEUED、RUNNING、FAILED 或 COMPLETED。
- targetDeploymentItemName 字符串必需
  
  人类可读标签，用于标识要将快照恢复到的目标项目上的集群。您可以将快照恢复到集群层 M2 或更高层。
  
  格式应符合以下模式：^[\p{L}\p{N}\-_.(),:&@+']{1,64}$。
- targetProjectId 字符串
  
  唯一的 24 位十六进制数字字符串，用于标识包含要将快照恢复到的集群的项目。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
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 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

POST /API/Atlas/v1.0/groups/{groupId}/clusters/{clusterName}/ 备份/tenant/ 恢复

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/tenant/restore' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"snapshotId":"32b6e34b3d91647abb20e7b8","targetDeploymentItemName":"string","targetProjectId":"32b6e34b3d91647abb20e7b8"}'

请求示例

{
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

响应示例 (200)

{
  "clusterName": "string",
  "deliveryType": "RESTORE",
  "expirationDate": "2025-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreFinishedDate": "2025-05-04T09:42:00Z",
  "restoreScheduledDate": "2025-05-04T09:42:00Z",
  "snapshotFinishedDate": "2025-05-04T09:42:00Z",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "snapshotUrl": "string",
  "status": "PENDING",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

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

为一个 M2 或 M5 集群创建一个恢复作业 已弃用

路径参数

查询参数

body 必需

响应

为一个 M2 或 M5 集群创建一个恢复作业已弃用