Obtener el estado de automatización de los últimos 50 planes

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

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.

Overview

Recupera los 50 planes más recientes para los procesos de MongoDB. Los planes son un conjunto de acciones necesarias para llevar una implementación de MongoDB al goalVersion.

El punto final devuelve el campo goalVersion para informar la versión de la configuración de automatización que describe el objeto de respuesta y el campo lastGoalVersionAchieved para informar las versiones de la configuración que se ejecutan en cada servidor.

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

Resource

GET /groups/GROUP-ID/automationStatus/full

Request Parameters

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
ID DE GRUPO	string	(Obligatorio) El identificador único del grupo.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

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

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	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
Versión de objetivo	Número	La versión de la Configuración de automatización. Si hay un conflicto en el envío de configuraciones de automatización, este campo muestra la configuración ganadora.
procesos	arreglo	Instancias de MongoDB implementadas en el proyecto.
proceso.código de error	entero	El código de error. Devuelve `0` si el proceso no tiene errores.
proceso.errorCodeDescription	string	Descripción detallada del error. Devuelve una string vacía si el proceso no presenta errores.
proceso.errorCodeHumanReadable	string	Descripción breve del error. Devuelve una cadena vacía si el proceso no tiene errores.
proceso.errorString	string	Salida de la línea de registro que contiene el error. Examine este campo para obtener contexto adicional del error. Devuelve una cadena vacía si el proceso no tiene errores.
procesos.nombredehost	string	El nombre de dominio completo (recuperado al emitir `hostname -f`) del servidor en el que están alojados el proceso MongoDB y la automatización.
procesos.nombre	string	El nombre del proceso tal como se especifica en la configuración de automatización.
procesos.últimaVersiónObjetivoLograda	Número	La última versión de la configuración de automatización con la que se implementó este proceso, según la configuración. Si el número `processes.lastGoalVersionAchieved` no es igual al número `goalVersion`, el proceso aún no se ha implementado según la configuración actual.
procesos.plan	arreglo	Describe cómo un proceso que aún no está actualizado con la configuración alcanzará el estado objetivo.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
  --header 'Accept: application/json' \
  --include \
  --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/automationStatus/full"

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

{
     "goalVersion": 11,
     "processes": [{
             "errorCode": 0,
             "errorCodeDescription": "",
             "errorCodeHumanReadable": "",
             "errorString": "",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 11,
             "name": "myReplicaSet_3",
             "plan": ["Download",
                     "WaitRsInit",
                     "WaitFeatureCompatibilityVersionCorrect"
             ]
     }, {
             "errorCode": 100,
             "errorCodeDescription": "There is an issue with file permissions for this process",
             "errorCodeHumanReadable": "File Permissions Error",
             "errorString": "<myReplicaSet_1> [13:11:33.348] Failed to compute states : <myReplicaSet_1> [13:11:33.348] Error calling ComputeState : <myReplicaSet_1> [13:11:33.348] Error getting fickle state for current state : <myReplicaSet_1> [13:11:33.348] Error checking if process is running from dbpath = /data/0 : <myReplicaSet_1> [13:11:33.348] Error getting file contents of /data/0/mongod.lock as string : <myReplicaSet_1> [13:11:33.348] Error reading file from /data/0/mongod.lock : open /data/0/mongod.lock: permission denied",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 1,
             "name": "myReplicaSet_1",
             "plan": ["Download"]
     }, {
             "errorCode": 0,
             "errorCodeDescription": "",
             "errorCodeHumanReadable": "",
             "errorString": "",
             "hostname": "example.net",
             "lastGoalVersionAchieved": 11,
             "name": "myReplicaSet_2",
             "plan": ["Download",
                     "Start",
                     "WaitRsInit",
                     "WaitFeatureCompatibilityVersionCorrect",
                     "AdjustRoles"
             ]
     }]
}

Volver

Obtener estado

Manifiesto de la versión