返回所有传统备份恢复作业 已弃用

获取 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs

返回指定项目中一个集群的所有传统备份恢复作业。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目只读”角色。

自 2020 年 3 月 23 日起,所有新集群只能使用云备份。当您升级到 4.2 时,如果备份系统当前设置为传统备份,则它会升级到云备份。升级后,所有现有的传统备份快照仍然可用。它们会根据您的保留策略随时间的推移而过期。您的备份策略将重置为默认计划。如果您已为传统备份应用自定义备份策略,则必须按照云备份文档中概述的步骤重新创建该策略。如果您使用 BATCH-ID 查询参数,则可以检索指定批处理中的所有恢复作业。为分片集群创建恢复作业时,MongoDB Cloud 会为每个分片创建一个单独的作业,并为配置服务器创建另一个作业。每个作业都是批处理的一部分。但是,批处理不能包含副本集的恢复作业。

云备份文档

路径参数

  • 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

  • includeCount 布尔

    标志,用于指示响应是否返回响应中的列项总数 (totalCount)。

    默认值为true

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1,最大值为 500。默认值为 100

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1

  • pretty 布尔

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

    默认值为false

    Prettyprint
  • batchID 字符串

    唯一的 24 位十六进制数字字符串,用于标识要返回的恢复作业批次。为分片集群创建恢复作业时,应用程序会为每个分片创建单独的作业,再加上用于配置主机的作业,时间戳以 ISO 8601 日期和时间格式显示,采用 UTC 时区。其中每个作业都由单个批次组成。副本集的恢复作业不能作为批次的一部分。

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

响应

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

    正常

    隐藏响应属性 显示响应属性 对象
    • 结果 大量[对象]

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      隐藏结果属性 显示结果属性 对象
      • batchID 字符串

        唯一的 24-十六进制数字字符串,用于标识此恢复作业所属的批处理。此参数仅适用于分片集群恢复。

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

      • clusterId 字符串

        唯一的 24-十六进制数字字符串,用于标识具有要返回的快照的集群。此参数针对恢复集群而返回。

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

      • 集群名称 字符串

        人类可读标签,用于标识包含要检索的快照的集群。

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

      • 已创建 string(date-time)

        有人请求此恢复作业的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • 交付 对象 必需

        说明如何交付恢复的快照数据的方法和详细信息。

        隐藏交付属性 显示交付属性 对象
        • auth header 字符串

          下载恢复时使用的标头名称,与 "delivery.methodName" : "HTTP" 一起使用。

        • authValue 字符串

          下载恢复时要使用的标头值,与 "delivery.methodName" : "HTTP" 一起使用。

        • expireHours integer(int32)

          恢复作业完成后的小时数,表示快照下载文件的统一资源定位符 ( URL ) 何时过期。当 "delivery.methodName" : "HTTP" 时,资源返回此参数。

          最小值为 1

        • expires string(date-time)

          快照下载文件的统一资源定位符 ( URL ) 过期的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。当 "delivery.methodName" : "HTTP" 时,资源返回此参数。

        • maxDownloads integer(int32)

          正整数,表示可以使用快照下载文件的统一资源定位符 ( URL ) 的次数。当 "delivery.methodName" : "HTTP" 时,资源返回此参数。

          最小值为 1

        • methodName 字符串 必需

          人类可读标签,用于标识传递数据的方式。如果设立"delivery.methodName" : "AUTOMATED_RESTORE" ,则还必须设立: delivery.targetGroupId delivery.targetClusterName delivery.targetClusterId 。响应返回 ,因为自动恢复使用超文本传输协议"delivery.methodName" : "HTTP" (HTTP) 将恢复作业传送到目标托管。

          取值为 CLIENT_PIT_HTTPQUERYAUTOMATED_RESTOREHTTPTHIRD_PARTY_COPYCLIENT_PIT_SCPSCP

        • statusName 字符串

          MongoDB Cloud 收到此请求时可下载快照文件的状态。

          取值为 NOT_STARTEDIN_PROGRESSREADYFAILEDINTERRUPTEDEXPIREDMAX_DOWNLOADS_EXCEEDEDPENDING

        • targetClusterId 字符串

          24唯一的 -十六进制数字字符串,用于标识目标集群。使用“获取所有Atlas 备份快照”和“获取快照”端点的响应正文中返回的 clusterId。此参数在"delivery.methodName" : "AUTOMATED_RESTORE" 时适用。

          如果目标集群未启用备份,则有两个资源将返回具有空值的参数:

          • 获取所有Atlas 备份快照端点返回没有 clusterId 元素的空结果大量
          • 获取快照端点不返回 clusterId 参数。

          要使用 clusterId 参数返回响应,请使用 delivery.targetClusterName 参数或在目标集群上启用备份。

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

        • targetClusterName 字符串

          用于标识目标集群的人类可读标签。使用“获取所有Atlas 备份快照”和“获取快照”端点的响应正文中返回的 clusterName。此参数在"delivery.methodName" : "AUTOMATED_RESTORE" 时适用。

          如果目标集群未启用备份,则有两个资源将返回具有空值的参数:

          • 获取所有Atlas 备份快照端点返回没有 clusterId 元素的空结果大量
          • 获取快照端点不返回 clusterId 参数。

          要使用 clusterId 参数返回响应,请使用 delivery.targetClusterName 参数或在目标集群上启用备份。

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

        • targetGroupId 字符串

          唯一的 24-十六进制数字字符串,用于标识包含恢复作业的目标集群的项目。当 "delivery.methodName" : "AUTOMATED_RESTORE" 时,资源返回此参数。

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

        • url 字符串 已弃用

          统一资源定位符 (URL),您可以从中下载恢复的快照数据。 URL 包含验证密钥。当 "delivery.methodName" : "HTTP" 时,资源返回此参数。

        • urlV2 字符串

          统一资源定位符 (URL),您可以从中下载恢复的快照数据。这应该优先于 url 。验证密钥必须作为HTTP标头发送。当"delivery.methodName" : "HTTP" 时,资源返回此参数。

      • EncryptionEnabled 布尔

        指示是否有人对恢复的快照中的数据加密的标志。

      • groupId 字符串

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

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

      • 哈希 大量[对象]

        列表,其中包含将每个恢复文件映射到哈希校验和的文档。该参数会在您下载相应的 delivery.url 后生效。如果为"methodName" : "HTTP" ,则此列表包含一个表示 .tar.gz文件哈希值的对象。

        将一个恢复文件映射到一个哈希校验和和的键/值对。该参数会在您下载相应的 delivery.url 后生效。

        隐藏哈希属性 显示哈希属性 对象
        • 文件名 字符串

          标识哈希文件的人类可读标签。

        • 哈希 字符串

          映射到恢复文件的哈希校验和。

        • typeName 字符串

          人类可读标签,用于标识用于计算哈希值的哈希算法。

          值为 SHA1

      • id 字符串

        唯一的 24 位十六进制数字字符串,用于标识该恢复作业。

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

      • masterKeyUUID string(uuid)

        通用唯一标识符 (UUID),用于标识用于加密快照数据的密钥管理互操作性 (KMIP) 主密钥。此参数仅在 "encryptionEnabled" : "true" 时适用。

      • snapshotId 字符串

        唯一的 24 位十六进制数字字符串,用于标识要恢复的快照。如果设置了 snapshotId,则无法设置 oplogIncoplogTspointInTimeUTCMillischeckpointId

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

      • statusName 字符串

        人类可读标签,用于标识请求时可下载文件的状态。

        取值为 IN_PROGRESSBROKENKILLEDFINISHED

      • timestamp 对象

        BSON时间戳,指示oplog中的检查点令牌条目出现的时间。

        隐藏时间戳属性 显示时间戳属性 对象
        • 日期 string(date-time)

          oplog记录此数据库操作的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

        • 增量 integer(int32)

          oplog在特定日期和时间记录的数据库操作的顺序。

          最小值为 1199145600

    • 总计数 integer(int32)

      可用文档总数。如果 includeCount设立为 false,MongoDB Cloud 会忽略此值。总数为估计值,可能不准确。

      最小值为 0

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

GET /api/atlas/v2 /groups/{groupId}/clusters/{clusterName}/restoreJobs
atlas api legacyBackup listGroupClusterRestoreJobs --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.ListGroupClusterRestoreJobsApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		ListGroupClusterRestoreJobsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true"
响应示例 (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "batchId": "32b6e34b3d91647abb20e7b8",
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "clusterName": "string",
      "created": "2025-05-04T09:42:00Z",
      "delivery": {
        "authHeader": "string",
        "authValue": "string",
        "expirationHours": 42,
        "expires": "2025-05-04T09:42:00Z",
        "maxDownloads": 42,
        "methodName": "CLIENT_PIT_HTTP",
        "statusName": "NOT_STARTED",
        "targetClusterId": "32b6e34b3d91647abb20e7b8",
        "targetClusterName": "string",
        "targetGroupId": "32b6e34b3d91647abb20e7b8",
        "url": "string",
        "urlV2": "string"
      },
      "encryptionEnabled": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "hashes": [
        {
          "fileName": "string",
          "hash": "string",
          "links": [
            {
              "href": "https://cloud.mongodb.com/api/atlas",
              "rel": "self"
            }
          ],
          "typeName": "SHA1"
        }
      ],
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "masterKeyUUID": "string",
      "snapshotId": "32b6e34b3d91647abb20e7b8",
      "statusName": "IN_PROGRESS",
      "timestamp": {
        "date": "2025-05-04T09:42:00Z",
        "increment": 1199145600
      }
    }
  ],
  "totalCount": 42
}
响应示例 (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"
}