/ /

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

Nota

Los términos «grupos» y «proyectos» son sinónimos. Tu {PROJECT-ID} ID de grupo es el mismo que el tuyo. Para los grupos existentes, tu ID de grupo/proyecto permanece igual. En esta página se utiliza el término «grupo», más común, 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 endpoint devuelve el campo goalVersion para informar sobre 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://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/GROUP-ID/automationStatus/full

Request Parameters

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

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

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

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
goalVersion	Número	La versión de la automatización de la configuración. Si hay un conflicto en las presentaciones de configuraciones de automatización, este campo enumera la configuración ganadora.
Procesos	arreglo	Las instancias implementadas de MongoDB del proyecto.
process.errorCode	entero	El código de error. Devuelve `0` si el proceso no tiene errores.
process.errorCodeDescription	string	Descripción detallada del error. Devuelve una string vacía si el proceso no presenta errores.
process.errorCodeHumanReadable	string	Breve descripción del error. Devuelve una string vacía si el proceso no tiene errores.
process.errorString	string	Salida de la línea de registro que contiene el error. Examine este campo para obtener más contexto sobre el error. Devuelve una string vacía si el proceso no tiene errores.
processes.hostname	string	El nombre de dominio completamente calificado (recuperado emitiendo `hostname -f`) del servidor en el que se alojan el proceso de MongoDB y la Automatización.
processes.name	string	El nombre del proceso según lo especificado en la configuración de automatización.
processes.lastGoalVersionAchieved	Número	La última versión de la configuración de automatización con la cual este proceso se había implementado tal como se configuró. 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.planificar	arreglo	Describe cómo un proceso que aún no está actualizado con la configuración logrará el estado deseado.

Solicitud de ejemplo

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

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

{
     "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 del último plan

Autenticación federada