/ /

Trabajos de colección de registros del servidor

/ /

Recursos

Trabajos de colección de registros del servidor

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Trabajos de colección de registros del servidor

Listar servidores activos de Ops Manager

Devuelve una lista de todos los servidores activos de Ops Manager. Ops Manager considera que un servidor está activo si envió un latido (heartbeat) a la base de datos de la aplicación en los últimos 20 segundos. Utiliza este endpoint para descubrir válidos serverId los valores antes de enviar una solicitud de recopilación de registros.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /admin/servers

Roles necesarios

Requiere que el La API Key que llama a este endpoint tiene la Global Read Only rol.

Request Parameters

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
`pageNum`	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
`itemsPerPage`	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
`type`	string	Opcional	Tipo de servidor por el que filtrar. Pase este parámetro varias veces para incluir varios tipos (`?type=VALUE_1&type=VALUE_2`). El valor actualmente soportado es `MMS_SERVER`, que representa el servidor de aplicaciones de Ops Manager. Si omites este parámetro, Ops Manager devuelve todos los tipos (actualmente solo `MMS_SERVER`).	Todos los tipos
`status`	string	Opcional	Estado del servidor por el que filtrar. Actualmente, el único valor válido es `active`. Cualquier otro valor devuelve `400 INVALID_SERVER_STATUS`. Si omites este parámetro, Ops Manager devuelve los servidores activos.	`active`
`pretty`	booleano	Opcional	Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.	`false`
`envelope`	booleano	Opcional	Bandera que indica si se debe envolver la respuesta en un sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta o al código de estado de HTTP. Para remediar esto, establecer `envelope=true` en la consulta.	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

La respuesta incluye un arreglo de objetos de servidor, un arreglo de objetos de enlace y el número total de objetos de servidor recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	Arreglo de servidores activos de Ops Manager. Consulta resultados Documento incrustado.
`links`	arreglo	Arreglo de uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre URLs siguen la especificación de enlaces web (RFC 5988).
`totalCount`	Número	Número total de elementos en el conjunto de resultados. Puede exceder el tamaño de `results` cuando se pagina.

resultados Documento incrustado

Cada elemento results representa un servidor activo de Ops Manager.

Nombre	Tipo	Descripción
`results[n].serverId`	string	Identificador del servidor activo de Ops Manager.
`results[n].serverType`	string	Tipo de servidor. Actualmente, siempre devuelve `MMS_SERVER`.
`results[n].lastPing`	string	Marca de tiempo, en formato ISO 8601 UTC, cuando el servidor envió por última vez un latido.

Solicitud de ejemplo

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"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

{
  "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
}

Volver

Trabajos de colección de registros del servidor

Crear