Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Agentes

Recuperar todas as versões do agente para um projeto

Nesta página

  • Funções obrigatórias
  • Solicitar
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer um dos seguintes roles atribuídos:

Solicitar

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

GET /groups/{PROJECT-ID}/agents/versions

Parâmetros do caminho da solicitação

Nome
Tipo
necessidade
Descrição
PROJECT-ID
string
Obrigatório
Identificador único do projeto.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
Status
Código de resposta HTTP
envelope
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

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

Resposta

Nome
Tipo
Descrição
count
inteiro
Número de agentes que seu aplicativo de Ops Manager encontrou.
entries
Array de objetos
Detalhes de cada agente em cada host que esta aplicação de Ops Manager managed.
entries
.address
string
Endereço IPv6 para o host que executa este agente.
entries
.hostname
string
FQDN do host que executa este agente.
entries
.hostnameShort
string
Nome do host que executa este agente.
entries
.version
string
Versão deste agente que este host executa.
entries
.pingCount
inteiro
Contagem de ping recebidos deste agente.
entries
.confCount
inteiro
Contagem de chamadas de configuração recebidas deste agente.
entries
.tagName
string
Etiqueta para este agente se o backup estiver habilitado.
entries
.lastPing
número

Registro de data/hora no número de milissegundos decorridos desde a UNIX epoch quando o MongoDB Ops Manager recebeu o último ping desse agente.

Aplica-se a agentes de monitoramento e agentes MongoDB com o monitoramento habilitado.

entries
.lastConf
número
Registro de data/hora no número de milissegundos decorridos desde a UNIX epoch quando MongoDB Ops Manager o recebeu a última chamada de configuração desse agente.
entries
.msSinceLastConf
número
Número de milissegundos que se passaram desde a última chamada de configuração.
entries
.isPrimary
booleano
Sinalizador que indica se o host no qual este Agente é executado é o primary.
entries
.isManaged
booleano

Sinalizador que indica se o Ops Manager managed este agente.

Aplica-se apenas ao agente de monitoramento e agente de backup.

entries
.numProcess
inteiro
Número de processos MongoDB executados neste host.
entries
.isVersionOld
booleano
Sinalizador que indica que o agente instalado está desatualizado. A versão lançada atual deste agente excede a versão do agente instalado.
entries
.isVersionDeprecated
booleano
O sinalizador que indica que este agente está obsoleto. A versão mínima suportada desse agente excede a versão do agente instalado.
entries
.pingState
string

Estado atual deste agente. pingName retorna um dos seguintes valores:

  • ok

  • warning

  • error

entries
.isModule
booleano
O sinalizador que indica que esta entrada é um módulo do MongoDB Agent.
isAnyAgentNotManaged
booleano
Sinalizador que indica se algum agente é executado em um host em um estado não gerenciado.
isAnyAgentVersionDeprecated
booleano
Sinalizador que indica se algum agente em qualquer sistema executa uma versão obsoleta desse agente.
isAnyAgentVersionOld
booleano
Sinalizador que indica se algum agente em qualquer sistema executa uma versão não atual desse agente.
latestVersion
string
Versão mais recente deste tipo de agente.
links
Array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

minimumAgentVersionDetected
string
Versão mínima suportada deste agente instalado neste host.
minimumVersion
string
Versão mínima suportada desse agente que funciona com a instalação do Ops Manager.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/versions?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

1{
2  "count": 0,
3  "entries": [],
4  "isAnyAgentNotManaged": false,
5  "isAnyAgentVersionDeprecated": false,
6  "isAnyAgentVersionOld": false,
7  "latestVersion": "10.14.0.6304",
8  "links": [{
9      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current",
10      "rel": "self"
11    },
12    {
13      "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}",
14      "rel": "http://mms.mongodb.com/group"
15    }
16  ],
17  "minimumAgentVersionDetected": "10.14.0.6304",
18  "minimumVersion": "5.0.0.309"
19}

Voltar

Recuperar todas as versões do agente

Próximo

Criar uma chave de API do agente