获取监控配置设置

在此页面上

所需角色

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

所需角色

此资源需要 Project Automation Admin角色。

资源

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

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

请求

路径参数

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

查询参数

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

名称

类型

必要性

说明

默认

pretty

布尔

Optional

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

false

envelope

布尔

Optional

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

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

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

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

false

正文参数

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

响应

范围

类型

必要性

说明

configOverrides

对象

Optional

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

设置	数据类型
`mmsGroupId`	字符串
`mmsApiKey`	字符串
`mmsBaseUrl`	字符串
`httpProxy`	字符串
`krb5Principal`	字符串
`krb5Keytab`	字符串
`krb5ConfigLocation`	字符串
`gssapiServiceName`	字符串
`useSslForAllConnections`	布尔
`sslClientCertificate`	字符串
`sslClientCertificatePassword`	字符串
`sslTrustedServerCertificates`	字符串
`sslRequireValidServerCertificates`	布尔
`enableMunin`	布尔

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

请求示例

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \
5      --output currentMonitoringConfig.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/monitoring-agent.log",
3   "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log",
4   "logRotate": {
5     "sizeThresholdMB": 1000.0,
6     "timeThresholdHrs": 24
7   },
8   "username": "mms-automation"
9 }

← 更新备份配置设置

更新监控配置设置 →

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \
5	--output currentMonitoringConfig.json

1	{
2	"logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
3	"logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log",
4	"logRotate": {
5	"sizeThresholdMB": 1000.0,
6	"timeThresholdHrs": 24
7	},
8	"username": "mms-automation"
9	}