Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.
Utilice este punto final para realizar una solicitud para que el primario actual de un set de réplicas ceda su puesto, activar una nueva elección. MongoDB Ops Manager pone en cola una tarea en segundo plano para que el agente de automatización del host de destino la ejecute en su siguiente registro.
Si el proceso de destino no es el primario grabable cuando el agente ejecuta la tarea, la tarea se completa como una operación nula en lugar de fallar. Una vez que el primario deja de serlo, permanece no apto para la reelección durante la duración especificada por stepDownSecs.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDownRoles necesarios
La clave API que realiza esta solicitud debe tener el rol Project Automation Admin.
Parámetros de ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
ID del grupo | string | Requerido | string única de 24 dígitos hexadecimales que identifica tu proyecto. |
RS-ID | string | Requerido | Nombre del set de réplicas que contiene el proceso de destino. |
host-puerto | string | Requerido | Proceso de destino, como |
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 está en formato pretty-print. |
|
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:
|
|
Parámetros del cuerpo de la solicitud
El cuerpo de la solicitud acepta los siguientes ajustables opcionales. Si envía un cuerpo vacío, utilice {}.
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
stepDownSecs | entero | Número de segundos que el primario degradado permanece no elegible para la reelección. Debe ser mayor que |
|
secondaryCatchUpPeriodSecs | entero | Número de segundos para esperar a que un secundario retrasado se ponga al día antes de que el primario se degrade. Debe ser mayor o igual a | Ninguno |
expiresAfterSeconds | entero | Número de segundos que la solicitud permanece en cola para que un agente de automatización la recoja antes de que la tarea caduque. Debe ser mayor que |
|
Respuesta
MongoDB Ops Manager devuelve 202 Accepted con un encabezado Location que tiene como punto de referencia el endpoint de la tarea de reelección, y el documento de la tarea de reelección en el cuerpo de la respuesta.
Nombre | Tipo | Descripción |
|---|---|---|
ID | string | String única de 24dígitos hexadecimales que identifica la tarea de reelección. |
ID del grupo | string | string única de 24 dígitos hexadecimales que identifica el Proyecto. |
acción | string | Acción que realiza esta tarea. Devuelve |
replicaSetName | string | Nombre del set de réplicas de destino. |
Nombre del host | string | Nombre de host del proceso de destino. |
Puerto | entero | Puerto del proceso de destino. |
Estado | string | Estado de la tarea. Devuelve uno de los siguientes valores: |
noop | booleano | Indicador que indica si la operación se completó como una operación nula. Devuelve |
mensaje | string | Detalle legible por humanos sobre la tarea. MongoDB Ops Manager rellena este campo después de que el agente informa un resultado. |
creado | string | Marca de tiempo, en formato ISO 8601 UTC, cuando Ops Manager creó la tarea. |
últimaActualización | string | Marca de tiempo, en formato ISO 8601 UTC, cuando MongoDB Ops Manager actualizó por última vez la tarea. |
expira | string | Marca de tiempo, en formato ISO 8601 UTC, después de la cual un agente de automatización ya no procesa esta tarea. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown?pretty=true" \ --data '{ "stepDownSecs": 60, "secondaryCatchUpPeriodSecs": 10 }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 202 AcceptedVary: Accept-EncodingContent-Type: application/jsonLocation: https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}Strict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "id": "665a1234567890abcdef1234", "groupId": "5c8100bcf2a30b12ff88258f", "action": "STEP_DOWN", "replicaSetName": "rs0", "hostname": "node1.example.com", "port": 27017, "status": "QUEUED", "noOp": false, "message": null, "created": "2026-08-11T05:37:59Z", "lastUpdated": "2026-08-11T05:37:59Z", "expires": "2026-08-11T05:42:59Z"}Códigos de respuesta
HTTP Status | Código de error | Descripción |
|---|---|---|
202 | -- | Solicitud aceptada. Devuelve el documento de la tarea de reelección. |
400 | INVALID_PARAMETER | Un ajustable está fuera de rango, o el cuerpo de la solicitud incluye |
400 | VERSIÓN_DEL_AGENTE_DE_AUTOMATIZACIÓN_NO_COMPATIBLE | El agente de automatización del host de destino es anterior a |
401 | USUARIO_NO_AUTORIZADO | La clave API no tiene el rol |
401 | USUARIO_NO_PUEDE_ACCEDER_ORGANIZACION | El autor de la llamada está fuera de la organización del Proyecto. |
404 | AUTOMATION_CONFIG_NOT_FOUND | El proyecto no tiene ninguna configuración de automatización publicada. |
404 | CLUSTER_NO_ENCONTRADO |
|
404 | PROCESO_NO_EN_CLUSTER |
|
409 | REELECTION_AGENT_NOT_RESPONDING | El agente de automatización del host de destino no ha hecho ping a MongoDB Ops Manager recientemente. |
409 | REELECCIÓN_YA_EN_CURSO | Ya hay una tarea de reelección en cola o en ejecución para este set de réplicas. |