/ /

/ /

Gerente de Operaciones

API

Recursos

agentes

Recuperar todas las versiones del agente para un proyecto

Roles necesarios

Puede llamar correctamente a este punto final con cualquiera de los siguientes roles asignados:

Project Read Only

Solicitud

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

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

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
`PROJECT-ID`	string	Requerido	Identificador único del proyecto.

Parámetros de consulta de solicitud

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`count`	entero	Número de agentes que su aplicación Ops Manager ha encontrado.
`entries`	matriz de objetos	Detalles de cada agente en cada host que administra esta aplicación Ops Manager.
`entries` `.address`	string	Dirección IPv6 del host que ejecuta este agente.
`entries` `.hostname`	string	FQDN del host que ejecuta este agente.
`entries` `.hostnameShort`	string	Nombre de host que ejecuta este agente.
`entries` `.version`	string	Versión de este agente que ejecuta este host.
`entries` `.pingCount`	entero	Recuento de pings recibidos de este agente.
`entries` `.confCount`	entero	Recuento de llamadas de configuración recibidas de este agente.
`entries` `.tagName`	string	Etiqueta para este Agente si la copia de seguridad está habilitada.
`entries` `.lastPing`	Número	Marca de tiempo en la cantidad de milisegundos que han transcurrido desde la época UNIX cuando Ops Manager recibió el último ping de este Agente. Se aplica a agentes de monitoreo y agentes MongoDB con monitoreo habilitado.
`entries` `.lastConf`	Número	Marca de tiempo en la cantidad de milisegundos que han transcurrido desde la época de UNIX cuando Ops Manager recibió la última llamada de configuración de este Agente.
`entries` `.msSinceLastConf`	Número	Número de milisegundos que han transcurrido desde la última llamada de configuración.
`entries` `.isPrimary`	booleano	Bandera que indica si el host en el que se ejecuta este Agente es el principal.
`entries` `.isManaged`	booleano	Bandera que indica si Ops Manager administra este Agente. Se aplica únicamente a agentes de monitoreo y respaldo.
`entries` `.numProcess`	entero	Número de procesos de MongoDB que se ejecutan en este host.
`entries` `.isVersionOld`	booleano	Indicador que indica que el agente instalado está desactualizado. La versión actual de este agente supera la versión del agente instalado.
`entries` `.isVersionDeprecated`	booleano	Indicador que indica que este agente está obsoleto. La versión mínima compatible de este agente supera la versión del agente instalado.
`entries` `.pingState`	string	Estado actual de este agente. `pingName` devuelve uno de los siguientes valores: `ok` `warning` `error`
`entries` `.isModule`	booleano	Bandera que indica que esta entrada es un módulo del Agente MongoDB.
`isAnyAgentNotManaged`	booleano	Bandera que indica si algún agente se ejecuta en un host en un estado no administrado.
`isAnyAgentVersionDeprecated`	booleano	Bandera que indica si algún Agente en cualquier implementación ejecuta una versión obsoleta de ese Agente.
`isAnyAgentVersionOld`	booleano	Bandera que indica si algún Agente en cualquier implementación ejecuta una versión no actual de ese Agente.
`latestVersion`	string	Última versión de este tipo de Agente.
`links`	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`minimumAgentVersionDetected`	string	Versión mínima compatible de este agente instalado en este host.
`minimumVersion`	string	Versión mínima compatible de este agente que funciona con su instalación de Ops Manager.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/versions?pretty=true"

Ejemplo de respuesta

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}

Cuerpo de respuesta

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 }

Volver

Recuperar todas las versiones

Crear clave API

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	}