获取所有项目备份作业配置

在此页面上

Resource

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

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

检索所有项目备份作业的配置。

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

Resource

GET /groups

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

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

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用 prettyprint 格式的标志格式。	`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` 嵌入式文档

每个结果都是一个项目的备份作业。

名称	类型	说明
daemonFilter	对象数组	备份守护程序主机及其头部目录对的大量，此项目的备份作业仅限于此。
daemonFilter.headRootDirectory	字符串	此备份守护程序主机上标头目录的根目录相对路径。
daemonFilter.machine	字符串	一个备份守护程序主机的主机地址。
id	字符串	表示此项目及其备份作业配置的唯一标识符。
kmipClientCertPassword	字符串	用于加密KMIP客户端证书的密码。
kmipClientCertPath	字符串	备份守护程序主机上存储KMIP客户端证书的目录路径。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
labelFilter	字符串数组	一大量标签，用于限制哪些备份守护程序和快照存储可以进程该项目的备份作业。
oplogStoreFilter	对象数组	表示可用于此项目备份作业的oplog存储的唯一标识符数组。
oplogStoreFilter.id	字符串	表示可用于此项目备份作业的oplog 存储的唯一标识符。
oplogStoreFilter.type	字符串	要使用的oplog 存储的类型。此值始终为`oplogStore` 。
snapshotStoreFilter	对象数组	表示可用于此项目备份作业的特定快照存储及其类型的唯一标识符数组。如果省略，则使用所有可用的快照存储。
snapshotStoreFilter.id	字符串	表示可用于此项目备份作业的特定快照存储的唯一标识符。
snapshotStoreFilter.type	字符串	特定快照存储的类型以`snapshotStoreFilter.id`给出。此选项可接受的值为： `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	字符串数组	可用于此项目的备份作业的同步存储筛选器数组。如果省略，则使用所有可用的同步存储。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?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" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "daemonFilter" : [ {
      "headRootDirectory" : "/data/backup",
      "machine" : "http://backup.example.com"
    } ],
    "id" : "{PROJECT-ID}",
    "kmipClientCertPassword" : "P4$$w0rD",
    "kmipClientCertPath" : "/certs/kmip",
    "labelFilter" : [ "label1", "label2" ],
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",
      "rel" : "self"
    }, {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",
      "rel" : "http://mms.mongodb.com/group"
    } ],
    "oplogStoreFilter" : [ {
      "id" : "oplog1",
      "type" : "oplogStore"
    } ],
    "snapshotStoreFilter" : [ {
      "id" : "sPid",
      "type" : "s3blockstore"
    } ],
    "syncStoreFilter" : [ "s1", "s2" ]
  } ],
  "totalCount" : 1
}

后退

按 ID 获取一个项目备份作业配置

来年