/ /

Gerente de Operaciones

API

Recursos

agentes

Obtener agentes por tipo para un proyecto

Obtener todos los agentes de un tipo especificado (es decir, Supervisión, copia de seguridad o automatización) para un proyecto.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece como se indica en el documento.

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

Resource

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

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único de la proyecto que posee la clave API del agente.
Tipo	string	El tipo de agente a recuperar. TYPE puede ser uno de los siguientes valores: `MONITORING` `BACKUP` `AUTOMATION`

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que señala si el cuerpo de la respuesta debe estar en un prettyprint formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

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

Respuesta

Nombre	Tipo	Descripción
`typeName`	string	El tipo de agente: `MONITORING`, `BACKUP` o `AUTOMATION`.
`hostname`	string	Nombre del host principal. Un host generalmente puede tener alias, por lo que el principal es el mejor nombre disponible según lo decida el Ops Manager.
`confCount`	Número	Número de llamadas de configuración.
`lastConf`	Marca de tiempo	Fecha y hora de la última llamada de configuración.
`stateName`	string	El estado actual del agente. `stateName` puede devolver los siguientes valores: `ACTIVE`: el agente está activo y funcionando `STANDBY`El agente está en espera `NO_PROCESSES`el agente no está gestionando, supervisando o realizando copias de seguridad de ningún proceso.
`pingCount`	Número	Sólo aplicable a los agentes de supervisión. El número de pings que el agente de supervisión ha enviado a la URL `hostname`.
`isManaged`	Booleano	Solo aplicable a los agentes de supervisión y respaldo. Especifica si Ops Manager gestiona o no al agente.
`lastPing`	Marca de tiempo	Sólo aplicable a los agentes de supervisión. Hora del ping más reciente.
`tag`	string	Solo aplicable a los agentes de copias de seguridad. La etiqueta del agente, si hay alguna.

Solicitud de ejemplo

Obtener todos los agentes de supervisión para un Proyecto.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"

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" : [],
  "results": [
    {
      "confCount": 59,
      "hostname": "example",
      "isManaged": true,
      "lastConf": "2015-06-18T14:21:42Z",
      "lastPing": "2015-06-18T14:21:42Z",
      "pingCount": 6,
      "stateName": "ACTIVE",
      "typeName": "MONITORING"
    }
  ],
  "totalCount": 1
}

Volver

Obtener todo

Recuperar todas las versiones