/ /

更新全局应用设置

更新 MongoDB Ops Manager 安装的全局应用程序设置。仅包含要更改的设置。MongoDB Ops Manager 会使所有其他设置保持不变。

所需角色

要成功调用此端点，您的API密钥必须具有 Global Owner角色。

请求

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

PATCH /admin/settings

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否采用 pretty-print 格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

字段	类型	必要性	说明
`dbProperties`	对象	必需	要更新或添加的全局应用设置的键值对。请求中未包含的设置保持不变。要删除设置，请将其值设置为 `null`。

重要

Ops Manager 会拒绝包含 mms.app.upgradeMode 的任何请求，无论值是什么。这些请求会返回带有 INVALID_SETTINGS_EXCEPTION 错误代码的 400 错误。

验证针对现有设置和提交设置的合并集运行，而不仅仅针对提交的属性。如果某个字段是您提交的设置的依赖项，并且尚未配置，则即使您未包含该字段，请求也可能会失败。示例，如果 mms.mail.hostname 没有现有值，则提交 {"mms.emailDaoClass": "SIMPLE_MAILER"} 会导致 detail: "mms.mail.hostname must not be blank" 失败。

响应

字段	类型	说明
`restartRequired`	布尔	指示是否必须重启 MongoDB Ops Manager 才能使更新的设置生效。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

响应示例

响应标头

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   "restartRequired": false
3 }

后退

获取设置

来年