Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
自动化
/
配置资源

获取备份配置设置

在此页面上

  • 所需角色
  • Resource
  • 请求
  • 路径参数
  • 查询参数
  • 正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

所需角色

此资源需要 Project Automation Admin角色。

Resource

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

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

请求

路径参数

名称
类型
必要性
说明

PROJECT-ID

字符串

必需

唯一的 24-十六进制数字string ，用于标识拥有该配置的项目。

查询参数

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

名称
类型
必要性
说明
默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

false

正文参数

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

响应

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-自动化 。

请求示例

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/backupAgentConfig?pretty=true" \
     --output currentBackupConfig.json

响应示例

响应标头

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  "logPath": "/var/log/mongodb-mms-automation/backup-agent.log",
3  "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\backup-agent.log",
4  "logRotate": {
5    "sizeThresholdMB": 1000.0,
6    "timeThresholdHrs": 24
7  },
8  "username": "mms-automation"
9}

后退

更新代理版本

来年

更新备份配置设置