Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API 资源
/
备份和恢复
/
快照

获取一个配置服务器的所有快照

在此页面上

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

重要

在使用 MongoDB 3.4 时已弃用

从 MongoDB 3开始。 4 ，镜像配置服务器部署（也称为 SCCC ）不再受支持。以下 API 方法仅适用于SCCC配置服务器。副本集配置服务器（也称为CSRS ）使用 “获取一个集群的所有快照”方法。要了解如何将配置服务器从SCCC转换为CSRS ，请参阅 MongoDB 服务器手册中的将配置服务器升级到副本集。

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

资源

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots

请求参数

请求路径参数

名称
类型
说明
PROJECT-ID
字符串
HOST-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

请求正文参数

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

响应

响应文档

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

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

results 嵌入式文档

每个结果都是一个快照。

名称
类型
说明
clusterId
快照代表的集群的 ID。
完成
布尔
指示快照已创建。 如果快照创建作业仍在进行中，则为false 。
已创建
文档
created.date
timestamp
ISO8601 中拍摄快照的确切时间点 UTC 格式的日期和时间。
created.increment
整型
在该确切时间点发生此快照的操作顺序。 要了解时间戳在 MongoDB 中的工作原理，请参阅时间戳。
doNotDelete
布尔

指示无法删除快照的指示器。

如果将doNotDelete设置为true ，则expires中的任何值都将被忽略。

expires
timestamp

ISO8601 的日期 UTC 格式的日期和时间，在此之后可以删除此 快照 。

如果将doNotDelete设置为true ，则删除expires中的所有值。

如果expires值早于当前日期和时间，则无法再对其进行编辑。

groupId
ObjectId
拥有 快照 的 项目 ID。
id
ObjectId
lastOplogAppliedTimestamp
文档
应用了最后一个 oplog 条目的时间戳组件。
lastOplogAppliedTimestamp.date
timestamp
在 ISO8601 中应用最后一个 oplog 的确切时间点 UTC 格式的日期和时间。
lastOplogAppliedTimestamp.increment
整型
在此确切时间点应用最后一个oplog的操作顺序。 要了解时间戳在 MongoDB 中的工作原理，请参阅时间戳。
链接
对象数组

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

命名空间筛选器列表
对象数组
namespaceFilterList.filterList
字符串数组

以逗号分隔的列表，其中包含快照中独占包含或显式排除的数据库或命名空间的任意组合。

默认值为空数组 ( [] )。

namespaceFilterList.filterType
字符串

一个值，用于确定如何为此快照筛选命名空间。

  • 如果将此值设置为blacklist ，则快照中会排除namespaceFilterList.filterList中的命名空间。

  • 如果将此值设置为whitelist ，则快照中仅包含namespaceFilterList.filterList中的命名空间。

默认值为 blacklist。

零件
对象数组
构成完整快照的各个部分。 该数组包含一个文档。
parts.dataSizeBytes
数字
快照中数据的总大小（以字节为单位）。
parts.encryptionEnabled
布尔
快照数据加密状态的指示器。
parts.fileSizeBytes
数字
数据文件的总大小（以字节为单位）。
parts.hostId
字符串
配置服务器的 ID。
parts.masterKeyUUID
ObjectId
用于加密快照数据的 KMIP 主密钥 ID。仅当此快照具有 时，才会显示parts.masterKeyUUID parts.encryptionEnabled : true。
parts.mongodVersion
字符串
创建快照时正在运行的mongod版本。
parts.storageSizeBytes
数字
为文档存储分配的空间总大小。
parts.typeName
字符串

该部分代表的服务器类型：

  • CONFIG_SERVER

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "clusterId" : "{CLUSTER-ID}",
    "complete" : true,
    "created" : {
      "date" : "2016-08-21T23:47:38Z",
      "increment" : 1
    },
    "doNotDelete" : false,
    "expires" : "2017-08-20T23:47:38Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{SNAPSHOT-ID}",
    "links" : [ {
      "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
      "rel" : "self"
    } ],
    "namespaceFilterList" : {
      "filterList" : [ ],
      "filterType" : "blacklist"
    },
    "parts" : [ {
      "clusterId" : "{CLUSTER-ID}",
      "compressionSetting" : "GZIP",
      "dataSizeBytes" : 503779557,
      "encryptionEnabled" : false,
      "fileSizeBytes" : 2855605344,
      "mongodVersion" : "4.0.9",
      "replicaSetName" : "proton",
      "storageSizeBytes" : 547516416,
      "typeName" : "REPLICA_SET"
    } ]
  }, {
  } ],
  "totalCount" : 28
}

后退

从集群中删除一个快照