更新备份配置设置

在此页面上

所需角色

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

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth2.0 身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

所需角色

此资源需要 Project Automation Admin角色。

Resource

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

PUT /groups/{PROJECT-ID}/automationConfig/backupAgentConfig

请求

路径参数

名称	类型	必要性	说明
PROJECT-ID	字符串	必需	唯一的 24-十六进制数字string ，用于标识拥有该配置的项目。

查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

正文参数

Parameter

类型

必要性

说明

configOverrides

对象

Optional

由于您的备份设置与MongoDB Agent的备份设置不同而需要更改的 MongoDB Agent设置列表。从旧版助手升级到 MongoDB 助手时，请配置此选项。

设置	数据类型
`mmsGroupId`	字符串
`mmsApiKey`	字符串
`mothership`	字符串
`mothershipResponseHeaderTimeout`	整型
`https`	布尔
`httpProxy`	字符串
`krb5Principal`	字符串
`krb5Keytab`	字符串
`krb5ConfigLocation`	字符串
`gsapiServiceName`	字符串
`sslClientCertificate`	字符串
`sslClientCertificatePassword`	字符串
`sslTrustedServerCertificates`	字符串
`sslRequireValidServerCertificates`	布尔
`sslTrustedMMSBackupServerCertificate`	字符串

logPath

字符串

Optional

此 MongoDB 助手写入日志的绝对文件路径。如果未指定，则在基于 UNIX 和 Linux 的系统上，日志将写入标准错误 ( stderr )，在 Windows 系统上，日志将写入事件日志。

logRotate

对象

Optional

此 MongoDB Agent 轮换备份日志的阈值。

logRotate

.sizeThresholdMB

整型

Optional

此 MongoDB Agent 轮换日志文件之前的最大大小（以 MB 为单位）。

logRotate

.timeDurationHrs

整型

Optional

此 MongoDB Agent 轮换日志文件的小时数。

用户名

字符串

Optional

应用程序数据库中管理备份日志的 MongoDB 用户。

如果使用API为 MongoDB Agent 启用身份验证，请在执行此端点时将此参数设置为mms-自动化 。

响应

Parameter

类型

必要性

说明

configOverrides

对象

Optional

由于您的备份设置与MongoDB Agent的备份设置不同而需要更改的 MongoDB Agent设置列表。从旧版助手升级到 MongoDB 助手时，请配置此选项。

设置	数据类型
`mmsGroupId`	字符串
`mmsApiKey`	字符串
`mothership`	字符串
`mothershipResponseHeaderTimeout`	整型
`https`	布尔
`httpProxy`	字符串
`krb5Principal`	字符串
`krb5Keytab`	字符串
`krb5ConfigLocation`	字符串
`gsapiServiceName`	字符串
`sslClientCertificate`	字符串
`sslClientCertificatePassword`	字符串
`sslTrustedServerCertificates`	字符串
`sslRequireValidServerCertificates`	布尔
`sslTrustedMMSBackupServerCertificate`	字符串

logPath

字符串

Optional

logRotate

对象

Optional

此 MongoDB Agent 轮换备份日志的阈值。

logRotate

.sizeThresholdMB

整型

Optional

此 MongoDB Agent 轮换日志文件之前的最大大小（以 MB 为单位）。

logRotate

.timeDurationHrs

整型

Optional

此 MongoDB Agent 轮换日志文件的小时数。

用户名

字符串

Optional

应用程序数据库中管理备份日志的 MongoDB 用户。

如果使用API为 MongoDB Agent 启用身份验证，请在执行此端点时将此参数设置为mms-自动化 。

请求示例

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/backupAgentConfig?pretty=true" \
     --data '{
       "configOverrides" : {
         "mmsBaseUrl" : "http://new.example.org"
       },
       "logPath": "/var/log/mongodb-mms-automation/backup-agent.log",
       "logRotate": {
         "sizeThresholdMB": 1000,
         "timeThresholdHrs": 12
       },
       "username": "mms-automation"
     }'

响应示例

响应标头

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}

响应体

此端点返回一个空的JSON对象。

后退

获取备份配置设置

来年

获取监控配置设置