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

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

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

配置新的备份守护程序。

注意

首次配置备份守护程序时，请使用此端点。在使用此端点进行配置之前，请确保备份守护程序进程正在运行。

如果您已经配置了备份守护程序，请使用更新一个备份守护程序配置端点进行更新。

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

Resource

PUT /daemon/configs/{MACHINE}

请求路径参数

名称	类型	必要性	说明
机器	字符串	必需	为备份守护程序提供服务的计算机的主机名或 IP 地址。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印的标志格式。

false

envelope

布尔

Optional

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

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

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

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

false

请求正文参数

名称	类型	必要性	说明
`assignmentEnabled`	布尔	Optional	指示是否可以为此备份守护进程分配备份作业的标志。
`backupJobsEnabled`	布尔	Optional	指示此备份守护进程是否可用于备份数据库的标志。
`configured`	布尔	Optional	指示此备份守护程序是否已准备就绪可供使用的标志。
`garbageCollectionEnabled`	布尔	Optional	指示此备份守护进程是否设置了垃圾回收的标志。
`headDiskType`	字符串	Optional	用于存储头部目录的磁盘类型。此选项可接受的值为： `HDD` `SSD`
`id`	字符串	必需	此备份守护程序的唯一标识符。
`labels`	字符串数组	Optional	用于管理可以将哪些MongoDB Ops Manager 备份作业分配给哪些备份守护进程的标签数组。设置这些标签会限制此备份守护程序可以处理的备份作业。如果省略，则此备份守护程序只能处理不使用标签来筛选作业的项目的备份作业。
`machine`	对象	必需	备份守护进程主机及其头目录。
`machine.headRootDirectory`	字符串	Optional	此备份守护程序托管上标头部目录的根相对路径。此目录必须以斜杠 ( `/` ) 结尾。如果省略斜杠，备份守护程序会生成Java异常错误。
`machine.machine`	字符串	必需	备份守护程序托管的主机名或IP解决。
`numWorkers`	数字	Optional	可以执行任务的工作进程数量（即备份、恢复或groom）。
`resourceUsageEnabled`	布尔	Optional	指示此备份守护进程是否监控其资源使用情况的标志。
`restoreQueryableJobsEnabled`	布尔	Optional	指示此备份守护进程是否可以执行可查询恢复的标志。

响应

名称	类型	说明
`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`	布尔	指示此备份守护进程是否可以执行可查询恢复的标志。

请求示例

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/?pretty=true' \
6      --data '{
7        "assignmentEnabled" : true,
8        "backupJobsEnabled" : false,
9        "configured" : true,
10        "garbageCollectionEnabled" : true,
11        "headDiskType" : "SSD",
12        "id" : "{BACKUP-DAEMON-ID}",
13        "labels" : [ "l1", "l2" ],
14        "machine" : {
15          "headRootDirectory" : "/data/backup/",
16          "machine" : "localhost"
17        },
18        "numWorkers" : 50,
19        "resourceUsageEnabled" : true,
20        "restoreQueryableJobsEnabled" : true
21      }'

响应示例

响应标头

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}

响应体

1 {
2   "assignmentEnabled" : true,
3   "backupJobsEnabled" : false,
4   "configured" : true,
5   "garbageCollectionEnabled" : true,
6   "headDiskType" : "SSD",
7   "id" : "{BACKUP-DAEMON-ID}",
8   "labels" : [ "l1", "l2" ],
9   "links" : [ {
10     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/<machine.headRootDirectory>",
11     "rel" : "self"
12   }],
13   "machine" : {
14     "headRootDirectory" : "/data/backup/",
15     "machine" : "localhost"
16   },
17   "numWorkers" : 50,
18   "resourceUsageEnabled" : true,
19   "restoreQueryableJobsEnabled" : true
20 }

后退

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

来年

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"backupJobsEnabled" : false,
9	"configured" : true,
10	"garbageCollectionEnabled" : true,
11	"headDiskType" : "SSD",
12	"id" : "{BACKUP-DAEMON-ID}",
13	"labels" : [ "l1", "l2" ],
14	"machine" : {
15	"headRootDirectory" : "/data/backup/",
16	"machine" : "localhost"
17	},
18	"numWorkers" : 50,
19	"resourceUsageEnabled" : true,
20	"restoreQueryableJobsEnabled" : true
21	}'