检索 MongoDB Ops Manager 安装的全局应用程序设置。
所需角色
要成功调用此终结点，您的 API 密钥必须具有 Global Owner 角色。
请求
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /admin/settings请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否采用 pretty-print 格式的标志。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
字段 | 类型 | 说明 |
|---|---|---|
| 对象 | 存储在数据库中的全局应用设置的键值对。MongoDB Ops Manager 不会以明文形式返回秘密设置。 |
| 对象 | MongoDB Ops Manager 附带的默认配置文件中的键值对。这些设置与实例级配置覆盖文件不同。 |
| 对象 | 每实例数据库覆盖设置。您可以通过公共 API 读取这些设置，但不能更新这些设置。 |
| 对象 | 与实例级数据库覆盖关联的实例详情。 |
| 字符串数组 | 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 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}响应体
{ "dbProperties": { "mms.centralUrl": "https://ops-manager.example.com", "mms.https.CAFile": "/path/to/ca/file" }, "defaultFileProperties": { "mms.https.ClientCertificateMode": "none" }, "instanceOverrides": { "instance-1": { "reCaptcha.enabled.registration": "false" } }, "instanceDetails": { "instance-1": { "om.instance.runtime.availableProcessors": 2 } }, "secretProperties": [ "mms.smtp.password" ]}