Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API 资源
/
备份管理
/
备份守护程序配置

获取所有备份守护程序配置

在此页面上

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

检索所有备份守护程序的配置。

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

Resource

GET /daemon/configs

请求路径参数

此端点不使用 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 嵌入式文档

每个结果都是一个备份守护进程。

名称
类型
说明
assignmentEnabled
布尔
指示是否可以为此备份守护进程分配备份作业的标志。
backupJobsEnabled
布尔
指示此备份守护进程是否可用于备份数据库的标志。
configured
布尔
指示此备份守护程序是否已准备就绪可供使用的标志。
garbageCollectionEnabled
布尔
指示此备份守护进程是否设置了垃圾回收的标志。
headDiskType
字符串

用于存储头部目录的磁盘类型。

此选项可接受的值为：

  • HDD

  • SSD

id
字符串
labels
字符串数组
用于管理 可以将哪些MongoDB Ops Manager 备份作业 分配给哪些 备份守护进程的标签数组。
links
对象数组

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

machine
对象
machine.headRootDirectory
字符串
此 备份守护程序 托管上标 头部目录 的根相对路径。
machine.machine
字符串
备份守护程序托管的主机名或IP解决。
numWorkers
数字
可以执行任务的工作进程数量（即 备份、 恢复或groom） 。
resourceUsageEnabled
布尔
指示此备份守护进程是否监控其资源使用情况的标志。
restoreQueryableJobsEnabled
布尔

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?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/daemon/configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
     "assignmentEnabled" : true,
     "backupJobsEnabled" : false,
     "configured" : true,
     "garbageCollectionEnabled" : true,
     "headDiskType" : "SSD",
     "id" : "{DAEMON-CONFIG}",
     "labels" : [ "l1", "l2" ],
     "links" : [ {
       "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{DAEMON-CONFIG}",
       "rel" : "self"
     }],
     "machine" : {
       "headRootDirectory" : "/data/backup/",
       "machine" : "localhost"
     },
     "numWorkers" : 50,
     "resourceUsageEnabled" : true,
     "restoreJobsEnabled" : false,
     "restoreQueryableJobsEnabled" : true
  } ],
  "totalCount" : 1
}

后退

按 ID 获取一个备份守护程序配置

来年

创建一个备份守护程序配置