更新一个项目备份作业配置

在此页面上

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 /groups/{PROJECT-ID}

请求路径参数

名称	类型	说明
PROJECT-ID	字符串	表示此项目及其备份作业配置的唯一标识符。

请求查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

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

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

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

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

false

请求正文参数

名称	类型	说明
daemonFilter	对象数组	可选。备份守护程序主机及其头部目录对的大量，此项目的备份作业仅限于此。如果省略，则使用所有可用的备份守护程序。
daemonFilter.headRootDirectory	字符串	可选。此备份守护程序托管上标头部目录的根目录相对路径。
daemonFilter.machine	字符串	一个备份守护程序主机的主机地址。
id	字符串	表示此项目及其备份作业配置的唯一标识符。
kmipClientCertPassword	字符串	可选。用于加密KMIP客户端证书的密码。
kmipClientCertPath	字符串	可选。存储 KMIP 客户端证书的备份守护程序主机上的根目录相对路径。
labelFilter	字符串数组	可选。一大量标签，用于限制哪些备份守护程序和快照存储可以进程该项目的备份作业。如果快照存储或任何备份守护程序设置了与此`labelFilter`相同的`labels` ，则它们可以处理此项目的备份作业。如果省略，则项目的备份作业可以使用任何可用的备份守护程序或快照存储。
oplogStoreFilter	对象数组	可选。表示可用于此项目备份作业的oplog存储的唯一标识符数组。如果省略，则可以使用所有可用的 oplog 存储。
oplogStoreFilter.id	字符串	表示可用于此项目备份作业的oplog 存储的唯一标识符。通过 Get Alloplog Configurations 检索要使用的存储的`id` 。oplog
oplogStoreFilter.type	字符串	要使用的oplog 存储的类型。唯一支持的值为`oplogStore` 。
snapshotStoreFilter	对象数组	可选。表示可用于此项目备份作业的特定快照存储及其类型的唯一标识符数组。如果省略，则使用所有可用的快照存储。
snapshotStoreFilter.id	字符串	可选。表示可用于此项目备份作业的特定快照存储的唯一标识符。
snapshotStoreFilter.type	字符串	可选。特定快照存储的类型以`snapshotStoreFilter.id`给出。此选项可接受的值为： `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	字符串数组	可选。可用于此项目的备份作业的同步存储筛选器数组。如果省略，则使用所有可用的同步存储。

响应

名称	类型	说明
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' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}?pretty=true' \
 --data '{
  "daemonFilter" : [ {
     "headRootDirectory" : "/data/backup",
     "machine" : "http://backup.example.com"
   } ],
   "id" : "{PROJECT-ID}",
   "kmipClientCertPassword" : "P4$$w0rD",
   "kmipClientCertPath" : "/certs/kmip",
   "labelFilter" : [ "label1", "label2" ],
   "oplogStoreFilter" : [ {
     "id" : "oplog1",
     "type" : "oplogStore"
   } ],
   "snapshotStoreFilter" : [ {
     "id" : "sPid",
     "type" : "s3blockstore"
   } ],
   "syncStoreFilter" : [ "s1", "s2" ]
 }'

响应示例

响应标头

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}

响应体

{
  "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" ]
}

后退

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

来年