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

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

在此页面上

  • Resource
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

检索一个备份守护程序的配置。

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

Resource

GET /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}
名称
类型
必要性
说明
机器
字符串
必需
为备份守护程序提供服务的计算机的主机名或 IP 地址。
HEAD-ROOT-DIRECTORY
字符串
Optional
根相对 URL编码路径 此 备份守护程序 托管上 头部目录 的 。如果尚未配置备份守护程序，则可以省略。

请求查询参数

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

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 prettyprint 格式的标记。
false
envelope
布尔
Optional

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

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

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

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false

请求正文参数

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

响应

名称
类型
说明
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/{MACHINE}/{HEAD-ROOT-DIRECTORY}?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}

响应体

{
  "assignmentEnabled" : true,
  "backupJobsEnabled" : false,
  "configured" : true,
  "garbageCollectionEnabled" : true,
  "headDiskType" : "SSD",
  "id" : "5991a422ad5df350005dd062",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
    "rel" : "self"
  }],
  "machine" : {
    "headRootDirectory" : "/data/backup/",
    "machine" : "localhost"
  },
  "numWorkers" : 50,
  "resourceUsageEnabled" : true,
  "restoreJobsEnabled" : false,
  "restoreQueryableJobsEnabled" : true
}

后退

备份守护程序配置

来年

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