对于 AI 代理：可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

为一台旧版镜像配置服务器创建一项恢复作业

基本 URL： https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs

请求路径参数

名称
类型
说明

PROJECT-ID

字符串

拥有作业的项目的唯一标识符。

HOST-ID

字符串

作业所代表的镜像配置服务器( SCCC ) 的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

  • status: HTTP 响应代码

  • content：预期响应正文

false

请求正文参数

名称
类型
必要性
说明

checkpointId

字符串

可选的

分片集群检查点的唯一标识符，表示数据将恢复到的时间点。

条件：

  • 设置"delivery.methodName" : "AUTOMATED_RESTORE" 。

  • FCV4.0使用 或更早版本运行分片集群。

  • 无法设置oplogInc 、 oplogTs或pointInTimeUTCMillis 。

如果提供此设置，此端点会将截至此检查点的所有数据恢复到您在delivery对象中指定的数据库。

delivery

对象

必需

恢复的快照数据的传输方法和详细信息。

delivery
.expires

字符串

可选的

Timestamp in ISO 8601 date and time format in UTC after which the URL is no longer available.

delivery.methodName" : "HTTP"

delivery
.expirationHours

数字

可选的

恢复作业完成后，下载URL有效的小时数。

delivery.methodName" : "HTTP"

delivery
.maxDownloads

数字

可选的

下载 URL 可使用的次数。这必须大于等于 1。

delivery.methodName" : "HTTP"

delivery
.methodName

字符串

必需

Cloud Manager 传送数据的方式。 接受的值为：

  • AUTOMATED_RESTORE

  • HTTP

如果设置"delivery.methodName" : "AUTOMATED_RESTORE" ，则还必须设置：

  • delivery.targetGroupId 和

  • delivery.targetClusterId

此外，响应将delivery.methodName显示为HTTP 。 自动恢复使用HTTP方法将恢复作业传送到目标主机。

重要：自 2018 年三月 27 日起，通过 SCP 恢复发送已取消。

delivery
.targetClusterId

字符串

可选的

目标集群的唯一标识符。 使用“获取所有快照”和“获取快照”端点的响应正文中返回的clusterId 。

delivery.methodName" : "AUTOMATED_RESTORE".

如果目标集群上未启用备份，则“获取所有快照”端点将返回一个没有clusterId元素的空results数组，并且“获取快照”端点也不会返回clusterId元素。

delivery
.targetGroupId

字符串

可选的

包含恢复作业的目标集群的项目的唯一标识符。

delivery.methodName" : "AUTOMATED_RESTORE"

oplogTs

字符串

可选的

oplog 时间戳，以时间戳形式给出，以自UNIX 纪元以来经过的秒数表示。与 oplogInc 配对时，它们表示数据将恢复到的时间点。

在副本集上运行针对local.oplog.rs的查询，以查找所需的时间戳。

"delivery.methodName" : "AUTOMATED_RESTORE" 仅适用于副本集。

如果设置oplogTs ，则：

  • 必须设置oplogInc 。

  • 无法设置checkpointId或pointInTimeUTCMillis 。

如果您提供此设置，则此端点会将截至且包括此 Oplog 时间戳在内的所有数据恢复到您在delivery对象中指定的数据库。

oplogInc

字符串

可选的

32 位递增序数，表示给定秒内的操作。 与oplogTs配对时，它们表示数据将恢复到的时间点。

"delivery.methodName" : "AUTOMATED_RESTORE" 仅适用于副本集。

如果设置oplogInc ，则：

  • 必须设置oplogTs 。

  • 无法设置checkpointId或pointInTimeUTCMillis 。

如果您提供此设置，则此端点会将截至且包括此 Oplog 时间戳在内的所有数据恢复到您在delivery对象中指定的数据库。

pointInTimeUTCMillis

long

可选的

自 UNIX 纪元 ' 以来经过的毫秒数，表示数据将恢复到的时间点。此时间戳必须在当前时间的最后 24 小时内。

如果提供此设置，此端点会将截至此时间点的所有数据恢复到您在delivery对象中指定的数据库。

"delivery.methodName" : "AUTOMATED_RESTORE" 仅适用于副本集。

如果设置pointInTimeUTCMillis ，则无法设置oplogInc 、 oplogTs或checkpointId 。

snapshotId

字符串

可选的

要恢复的快照的唯一标识符。

响应

名称
类型
说明

batchID

字符串

条件： 仅限分片集群。 此恢复作业所属批处理的唯一标识符。

clusterId

字符串

条件： 仅限集群。 恢复作业所代表的集群的唯一标识符。

已创建

字符串

请求恢复作业时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。

交付

对象

恢复的快照数据的传输方法和详细信息。

delivery.expirationHours

数字

条件： "delivery.methodName" : "HTTP"。恢复作业完成后，下载URL有效的小时数。

delivery.expires

字符串

条件： "delivery.methodName" : "HTTP"。 ISO8601 格式的时间戳 UTC 格式的日期和时间，在此之后 URL 将不再可用。

delivery.maxDownloads

数字

条件： "delivery.methodName" : "HTTP". 下载 URL 可使用的次数。这必须大于等于 1。

delivery.methodName

字符串

数据传输方式。 接受的值为 HTTP

重要：自 2018 年三月 27 日起，通过 SCP 恢复发送已取消。

delivery.statusName

字符串

可下载文件的当前状态。 接受的值为：

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

delivery.targetClusterId

字符串

条件： delivery.methodName" : "AUTOMATED_RESTORE"。执行恢复作业的目标集群的唯一标识符。

delivery.targetGroupId

字符串

条件： delivery.methodName" : "AUTOMATED_RESTORE"。包含恢复作业的目标集群的项目的唯一标识符。

delivery.url

字符串

条件： "delivery.methodName" : "HTTP"。可以下载恢复的 快照 数据的 URL 。

groupId

字符串

拥有恢复作业的群组的唯一标识符。

哈希

对象数组

如果已下载相应的delivery.url ，则此数组中的每个文档都是恢复文件到哈希校验和的映射。 该数组仅在文件下载后才存在。

对于HTTP恢复，此大量仅包含一个表示.tar.gz文件哈希的对象。

hashes.fileName

字符串

已哈希的快照文件的名称。

hashes.hash

字符串

快照文件的哈希值。

hashes.typeName

字符串

用于计算哈希值的哈希算法。 如果存在，则此值为SHA1 。

hostId

字符串

条件：镜像配置服务器( SCCC )。 此恢复作业所属的配置服务器的唯一标识符。

id

字符串

恢复作业的唯一标识符。

链接

对象数组

指向子资源和/或相关资源的一个或多个链接。响应中的所有 links 数组至少包含一个名为 self 的链接。URL之间的关系在 Web 链接规范中进行了解释。

snapshotId

字符串

要恢复的快照的唯一标识符。

statusName

字符串

作业的当前状态。 接受的值为：

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

timestamp

对象

创建快照时 Oplog 条目的时间戳。

timestamp.date

字符串

恢复的快照中最新oplog条目的 ISO 8601 日期和时间格式的时间戳（UTC 格式）。

timestamp.increment

字符串

在恢复的快照中最新 oplog 条目完成的所有操作的顺序。

请求示例

创建使用HTTP传输压缩快照的恢复作业。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs?pretty=true" \     --data '      {        "delivery" : {          "expirationHours" : 1,          "expires" : "2017-04-21T04:49:57Z",          "maxDownloads" : 1,          "methodName" : "HTTP",          "statusName" : "READY",          "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"        },        "snapshotId" : "{SNAPSHOT-ID}"      }'

响应示例

响应标头

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{  "created" : "2017-08-25T16:22:15Z",  "delivery" : {    "expirationHours" : 1,    "expires" : "2017-04-21T04:49:57Z",    "maxDownloads" : 1,    "methodName" : "HTTP",    "statusName" : "READY",    "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"  },  "encryptionEnabled" : true,  "groupId" : "{PROJECT-ID}",  "hostId" : "{HOST-ID}",  "id" : "{JOB-ID}",  "links" : [ {    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}",    "rel" : "self"  }, {    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}",    "rel" : "http://mms.mongodb.com/cluster"  }, {    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}",    "rel" : "http://mms.mongodb.com/snapshot"  }, {    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",    "rel" : "http://mms.mongodb.com/group"  } ],  "masterKeyUUID" : "{UUID}",  "snapshotId" : "{SNAPSHOT-ID}",  "statusName" : "IN_PROGRESS"}
给本页内容打分

在此页面上