所需角色
此资源需要Project Automation Admin角色。
Resource
基本 URL： https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/automationConfig/backupAgentConfig请求
路径参数
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
PROJECT-ID | 字符串 | 必需 | 唯一的 24-十六进制数字string ，用于标识拥有该配置的项目。 |
查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式的标记。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
正文参数
此端点不使用 HTTP 请求正文参数。
响应
Parameter | 类型 | 必要性 | 说明 |
|---|---|---|---|
configOverrides | 对象 | Optional | 由于您的备份设置与MongoDB Agent的备份设置不同而需要更改的 MongoDB Agent设置列表。从旧版助手升级到 MongoDB 助手时，请配置此选项。
|
logPath | 字符串 | Optional | 此 MongoDB 助手写入日志的绝对文件路径。 如果未指定，则在基于 UNIX 和 Linux 的系统上，日志将写入标准错误 ( |
logRotate | 对象 | Optional | 此 MongoDB Agent 轮换备份日志的阈值。 |
logRotate | 整型 | Optional | 此 MongoDB Agent 轮换日志文件之前的最大大小（以 MB 为单位）。 |
logRotate | 整型 | Optional | 此 MongoDB Agent 轮换日志文件的小时数。 |
用户名 | 字符串 | Optional | 应用程序数据库中管理备份日志的 MongoDB 用户。 如果使用API为 MongoDB Agent 启用身份验证，请在执行此端点时将此参数设置为mms-automation 。 |
请求示例
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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "logPath": "/var/log/mongodb-mms-automation/backup-agent.log", "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\backup-agent.log", "logRotate": { "sizeThresholdMB": 1000.0, "timeThresholdHrs": 24 }, "username": "mms-automation"}