/ /

Trabalhos de coleção de registro do servidor

/ /

Recursos

Trabalhos de coleção de registro do servidor

Página inicial do Docs

Trabalhos de coleção de registro do servidor

Listar servidores do Ops Manager ativos

Retorna uma lista de todos os servidores ativos do Ops Manager. O Ops Manager considera um servidor ativo se tiver enviado uma pulsação para o banco de dados de aplicativos nos últimos 20 segundos. Use esse endpoint para descobrir valores de serverId válidos antes de enviar uma solicitação de coleção de registro.

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

Resource

GET /admin/servers

Funções obrigatórias

Requer que a chave deAPI que chama esse endpoint tenha a função Global Read Only .

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição	Default
`pageNum`	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
`itemsPerPage`	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
`type`	string	Opcional	Tipo de servidor pelo qual filtrar. Passe este parâmetro várias vezes para incluir vários tipos (`?type=VALUE_1&type=VALUE_2`). O valor atualmente suportado é `MMS_SERVER`, que representa o servidor de aplicação do Ops Manager. Se você omitir este parâmetro, o Ops Manager retornará todos os tipos (atualmente apenas `MMS_SERVER`).	Todos os tipos
`status`	string	Opcional	Status do servidor pelo qual filtrar. Atualmente, o único valor válido é `active`. Qualquer outro valor retorna `400 INVALID_SERVER_STATUS`. Se você omitir este parâmetro, o Ops Manager retornará servidores ativos.	`active`
`pretty`	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um formato pretty-print.	`false`
`envelope`	booleano	Opcional	Sinalizador que indica se a resposta deve ser agrupada em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope=true` na query.	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

A resposta inclui uma array de objetos de servidor , uma array de objetos de link e o número total de objetos de servidor recuperados.

Nome	Tipo	Descrição
`results`	array	Array de servidores ativos do Ops Manager. Veja o documento incorporado de resultados.
`links`	array	Array de um ou mais links para sub-recursos ou recursos relacionados. As relações entre URLs seguem a Especificação de Link da Web 5988 (RFC).
`totalCount`	número	Número total de itens no conjunto de resultados. Pode exceder o tamanho de `results` quando paginado.

documento incorporado de resultados

Cada elemento results representa um servidor Ops Manager ativo.

Nome	Tipo	Descrição
`results[n].serverId`	string	Identificador do servidor ativo do Ops Manager.
`results[n].serverType`	string	Tipo de servidor. Atualmente sempre retorna `MMS_SERVER`.
`results[n].lastPing`	string	Carimbo de data/hora, no formato ISO 8601 UTC, quando o servidor enviou pela última vez um heartbeat.

Exemplo de solicitação

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"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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

Voltar

Trabalhos de coleção de registro do servidor

criar