/ /

/ /

列出活动Ops Manager服务器

返回所有活动Ops Manager服务器的列表。如果服务器在最后 20 秒内向应用程序数据库发送了心跳，Ops Manager会认为服务器处于活动状态。在提交日志集合请求之前，使用此端点发现有效的 serverId 值。

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

Resource

GET /admin/servers

所需角色

要求调用此端点的 API密钥具有 Global Read Only角色。

请求参数

请求路径参数

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

请求查询参数

名称	类型	必要性	说明	默认
`pageNum`	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
`itemsPerPage`	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
`type`	字符串	Optional	作为过滤依据的服务器类型。多次传递此参数以包含多种类型 (`?type=VALUE_1&type=VALUE_2`)。当前支持的值为 `MMS_SERVER`，它代表Ops Manager应用程序服务器。如果省略此参数， Ops Manager将返回所有类型（当前仅 `MMS_SERVER`）。	所有类型
`status`	字符串	Optional	作为过滤依据的服务器状态。目前唯一有效值为 `active`。任何其他值都会返回 `400 INVALID_SERVER_STATUS`。如果省略此参数， Ops Manager将返回活动服务器。	`active`
`pretty`	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
`envelope`	布尔	Optional	指示是否将响应包装在信封中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立 `envelope=true`。	`false`

请求正文参数

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

响应

响应包括服务器对象大量、链接对象大量以及检索到的服务器对象总数。

名称	类型	说明
`results`	阵列	活动Ops Manager服务器的数组。请参阅嵌入式文档结果。
`links`	阵列	指向子资源或相关资源的一个或多个链接的数组。 URL 之间的关系遵循 Web 链接规范5988 (RFC)。
`totalCount`	数字	结果设立的项目总数。分页时可能会超过 `results` 的大小。

结果嵌入式文档

每个 results 元素代表一个活动Ops Manager服务器。

名称	类型	说明
`results[n].serverId`	字符串	活动Ops Manager服务器的标识符。
`results[n].serverType`	字符串	服务器类型。目前始终返回 `MMS_SERVER`。
`results[n].lastPing`	字符串	服务器上次发送心跳的时间戳，采用 ISO 8601 UTC 格式。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/servers?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}

响应体

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/servers?pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "serverId": "om-server-1.example.com",
      "serverType": "MMS_SERVER",
      "lastPing": "2026-04-13T10:00:15Z"
    },
    {
      "serverId": "om-server-2.example.com",
      "serverType": "MMS_SERVER",
      "lastPing": "2026-04-13T10:00:12Z"
    }
  ],
  "totalCount": 2
}

后退

服务器日志收集作业

来年

创建