/ /

/ /

Gerente de Operaciones

API

Recursos

agentes

Recuperar Todas las Versiones de 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 Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

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 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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

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

false

Parámetros del cuerpo de la solicitud

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

Respuesta

Nombre	Tipo	Descripción
`count`	entero	Número de agentes que su aplicación Ops Manager ha encontrado.
`entries`	Arreglo de objetos	Detalles de cada agente en cada host que esta aplicación de Ops Manager gestiona.
`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 del 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	Conteo 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 Unix epoch cuando Ops Manager recibió el último ping de este Agente. se aplica a los agentes de supervisión y agentes de MongoDB con supervisión habilitada.
`entries` `.lastConf`	Número	Timestamp en el número de milisegundos transcurridos desde la época UNIX cuando Ops Manager recibió la última llamada de configuración de este agente.
`entries` `.msSinceLastConf`	Número	Número de milisegundos que han pasado desde la última llamada de configuración.
`entries` `.isPrimary`	booleano	Indicador que muestra si el host en el que se ejecuta este agente es el primario.
`entries` `.isManaged`	booleano	Indicador que señala si Ops Manager gestiona este agente. Se aplica solo a los agentes de supervisión y agentes de copias de seguridad.
`entries` `.numProcess`	entero	Número de procesos de MongoDB que se ejecutan en este host.
`entries` `.isVersionOld`	booleano	Bandera que indica que el agente instalado está desactualizado. La versión actual liberada de este agente excede la versión del agente instalado.
`entries` `.isVersionDeprecated`	booleano	Indicador que indica que este agente está obsoleto. La versión mínima compatible con 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 MongoDB Agent.
`isAnyAgentNotManaged`	booleano	Indicador de si algún Agente se ejecuta en un host en un estado no administrado.
`isAnyAgentVersionDeprecated`	booleano	Indicador que señala si algún agente en cualquier implementación ejecuta una versión en desuso de ese Agente.
`isAnyAgentVersionOld`	booleano	Indicador si algún agente en cualquier implementación ejecuta una versión no actualizada de ese agente.
`latestVersion`	string	La versión más reciente de este tipo de Agente.
`links`	Arreglo de objetos	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
`minimumAgentVersionDetected`	string	Versión mínima compatible de este Agente instalada en este host.
`minimumVersion`	string	Versión mínima compatible de este agente que funciona con su instalación de Ops Manager.

Solicitud de ejemplo

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

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 de 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	}