Docs 菜单

Docs 主页 → MongoDB Ops Manager

获取一个集群的所有恢复作业

在此页面上

  • 资源
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

获取集群的所有恢复作业。 CLUSTER-ID必须是 副本集或分片集群的 ID。

注意

如果使用BATCH-ID查询参数，则可以检索指定批处理中的所有恢复作业。当为分片集群创建恢复作业时，Ops Manager会为每个分片创建一个单独的作业，并为配置服务器创建另一个作业。其中每个作业都是批处理的一部分。 但是，副本集的恢复作业不能作为批处理的一部分。

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

资源

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?batchId={BATCH-ID}

请求路径参数

名称
类型
说明
PROJECT-ID
字符串
拥有 快照 的 项目 的唯一标识符。
CLUSTER-ID
字符串
快照所代表的集群的唯一标识符。

请求查询参数

名称
类型
必要性
说明
默认
pageNum
数字
Optional
从一开始的整数，用于返回结果的一部分。
1
itemsPerPage
数字
Optional
每页要返回的项目数，最多 500 个。
100
pretty
布尔
Optional
指示响应正文是否应采用 美观打印 的标志 格式。
false
envelope
布尔
Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 envelope : true。

对于返回结果列表的端点， results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false
backupJobsEnabledOnly
布尔
Optional
指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。
true
批处理-ID
字符串
批处理的唯一标识符。
NONE

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明
results
阵列
数组为results嵌入式文档部分中详细介绍的每一项包含一个对象。
links
阵列
数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
totalCount
数字
结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

每个结果都是一个集群恢复作业。

名称
类型
说明
batchID
字符串
有条件：仅限分片集群。此恢复作业所属批处理的唯一标识符。
clusterId
字符串
有条件的：仅限集群。恢复作业所代表的集群的唯一标识符。
已创建
字符串
ISO8601 格式的时间戳 请求恢复作业时的日期和时间格式（ 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

重要

通过SCP的恢复交付已在 Ops Manager 4.0 中删除。

delivery.statusName
字符串

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

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

delivery.url
字符串
条件："delivery.methodName" : "HTTP" 。可以下载恢复的 快照 数据的 URL 。
EncryptionEnabled
布尔
指示恢复的快照数据是否已加密的标志。
groupId
字符串
拥有恢复作业的群组的唯一标识符。
哈希
对象数组

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

注意

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

hashes.fileName
字符串
已哈希的快照文件的名称。
hashes.hash
字符串
快照文件的哈希值。
hashes.typeName
字符串
用于计算哈希值的哈希算法。 如果存在，则此值为SHA1 。
hostId
字符串
条件：镜像配置服务器( SCCC )。此恢复作业所属的配置服务器的唯一标识符。
id
字符串
恢复作业的唯一标识符。
链接
对象数组

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

masterKeyUUID
字符串
条件："encryptionEnabled" : true 。用于加密 快照 数据的 KMIP 主密钥 ID 。
给定时间点
布尔
指示PIT恢复作业的标志。
snapshotId
字符串
要恢复的快照的唯一标识符。
statusName
字符串

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

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

timestamp
对象
创建快照时 Oplog 条目的时间戳。
timestamp.date
字符串
ISO8601 格式的时间戳 恢复的快照中最新 oplog 条目的日期和时间格式（ UTC 格式）。
timestamp.increment
字符串
在恢复的快照中最新 oplog 条目完成的所有操作的顺序。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true"

响应示例

响应标头

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

响应体

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2017-04-21T03:49:57Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2017-04-21T04:49:57Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "pointInTime" : false,
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-18T15:14:25Z",
      "increment" : 1
    }
  }, {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2017-04-18T19:21:23Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2017-04-18T20:21:23Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/NWRlMTk4NzgxYzNjNDIzOTg2Yzc3YzkyODYxYjNjMzY=/electron_0-1492528465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "pointInTime" : false,
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-19T21:14:25Z",
      "increment" : 1
    }
  } ],
  "totalCount" : 2
}
← 恢复作业
为一个集群获取一项恢复作业 →

在此页面上