/ /

/ /

Obtener agentes por tipo para un proyecto

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

Obtener todos los agentes de un tipo específico (es decir, Monitoreo, Respaldo o Automatización) para un proyecto.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

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

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único del 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 consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint 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 endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

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
`typeName`	string	El tipo de agente: `MONITORING`, `BACKUP` o `AUTOMATION`.
`hostname`	string	Nombre de host principal. Un host suele tener alias, por lo que el principal es el mejor nombre disponible según lo determine Cloud Manager.
`confCount`	Número	Número de llamadas de configuración.
`lastConf`	fecha y hora	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 en funcionamiento `STANDBY`:el agente está en espera `NO_PROCESSES`:el agente no administra, supervisa ni realiza copias de seguridad de ningún proceso.
`pingCount`	Número	Solo aplicable a agentes de monitorización. Número de pings que el agente de monitorización ha enviado a la `hostname` URL.
`isManaged`	Booleano	Solo aplicable a agentes de monitorización y backup. Especifica si Cloud Manager administra el agente.
`lastPing`	fecha y hora	Solo aplicable a agentes de monitoreo. Hora del ping más reciente.
`tag`	string	Solo aplicable a agentes de respaldo. La etiqueta del agente, si la tiene.

Ejemplo de solicitud

Obtenga todos los agentes de monitoreo para un proyecto.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"

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

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

Crear clave API