/ /

/ /

获取全局应用设置

检索 MongoDB Ops Manager 安装的全局应用程序设置。

所需角色

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

请求

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

GET /admin/settings

请求路径参数

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

请求查询参数

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

请求正文参数

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

响应

字段	类型	说明
`dbProperties`	对象	存储在数据库中的全局应用设置的键值对。MongoDB Ops Manager 不会以明文形式返回秘密设置。
`defaultFileProperties`	对象	MongoDB Ops Manager 附带的默认配置文件中的键值对。这些设置与实例级配置覆盖文件不同。
`instanceOverrides`	对象	每实例数据库覆盖设置。您可以通过公共 API 读取这些设置，但不能更新这些设置。
`instanceDetails`	对象	与实例级数据库覆盖关联的实例详情。
`secretProperties`	字符串数组	MongoDB Ops Manager 在数据库中作为加密值存储的设置名称。此列表的内容可能会在未来版本中更改。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true"

响应示例

响应标头

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   "dbProperties": {
3     "mms.centralUrl": "https://ops-manager.example.com",
4     "mms.https.CAFile": "/path/to/ca/file"
5   },
6   "defaultFileProperties": {
7     "mms.https.ClientCertificateMode": "none"
8   },
9   "instanceOverrides": {
10     "instance-1": {
11       "reCaptcha.enabled.registration": "false"
12     }
13   },
14   "instanceDetails": {
15     "instance-1": {
16       "om.instance.runtime.availableProcessors": 2
17     }
18   },
19   "secretProperties": [
20     "mms.smtp.password"
21   ]
22 }

后退

全局应用设置

来年

更新设置

1	{
2	"dbProperties": {
3	"mms.centralUrl": "https://ops-manager.example.com",
4	"mms.https.CAFile": "/path/to/ca/file"
5	},
6	"defaultFileProperties": {
7	"mms.https.ClientCertificateMode": "none"
8	},
9	"instanceOverrides": {
10	"instance-1": {
11	"reCaptcha.enabled.registration": "false"
12	}
13	},
14	"instanceDetails": {
15	"instance-1": {
16	"om.instance.runtime.availableProcessors": 2
17	}
18	},
19	"secretProperties": [
20	"mms.smtp.password"
21	]
22	}