返回所有活动Ops Manager服务器的列表。如果服务器在最后 20 秒内向应用程序数据库发送了心跳,Ops Manager会认为服务器处于活动状态。在提交日志集合请求之前,使用此终结点发现有效的 serverId 值。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/servers所需角色
要求调用此终结点的 API 密钥具有 Global Read Only 角色。
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
| 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 |
|
| 数字 | Optional | 每页要返回的项目数,最多 500 个。 |
|
| 字符串 | Optional | 要过滤的服务器类型。多次传递此参数以包含多种类型 (
如果省略此参数,MongoDB Ops Manager 将返回所有服务器类型。 | 所有类型 |
| 字符串 | Optional | 作为过滤依据的服务器状态。目前唯一有效值为 |
|
| 布尔 | Optional | 指示响应正文是否使用 prettyprint 格式。 |
|
| 布尔 | Optional | 指示是否要将响应封装在信封中。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 |
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应包括服务器对象数组、链接对象数组以及检索到的服务器对象总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 活跃的 MongoDB Ops Manager 服务器数组。请参阅结果嵌入式文档。 |
| 阵列 | 指向子资源或相关资源的一个或多个链接的数组。URL 之间的关系遵循 Web 链接规范 (RFC 5988)。 |
| 数字 | 结果设立的项目总数。分页时可能会超过 |
结果嵌入式文档
每个 results 元素代表一个活动Ops Manager服务器。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 活动Ops Manager服务器的标识符。 |
| 字符串 | 服务器类型。返回以下值之一: |
| 字符串 | 服务器上次发送心跳的时间戳,采用 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 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}响应体
{ "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" }, { "serverId": "daemon-host-1.example.com", "serverType": "BACKUP_DAEMON", "lastPing": "2026-04-13T10:00:10Z" }, { "serverId": "daemon-host-2.example.com", "serverType": "BACKUP_DAEMON", "lastPing": "2026-04-13T10:00:08Z" } ], "totalCount": 4}