Solicitar un conjunto de réplicas Paso a paso principal

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 solicitar que el nodo primario actual de un conjunto de réplicas ceda su rol, lo que desencadenará una nueva elección. 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 próxima comprobación de conexión.

Si el proceso de destino no es el proceso primario con permisos de escritura cuando el agente ejecuta la tarea, esta finaliza sin realizar ninguna operación en lugar de fallar. Una vez que el proceso primario deja de tener permisos, permanece inhabilitado para ser reelegido durante el período especificado por stepDownSecs.

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

Resource

POST /groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown

Roles 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.
ID RS	string	Requerido	Nombre del conjunto de réplicas que contiene el proceso de destino.
PUERTO DEL HOST	string	Requerido	Proceso objetivo, como `hostname:port`. Este proceso debe ser actualmente el principal del conjunto de réplicas.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta está en formato legible.	`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: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

El cuerpo de la solicitud acepta los siguientes parámetros configurables opcionales. Si envía un cuerpo vacío, utilice {}.

Nombre	Tipo	Descripción	predeterminado
stepDownSecs	entero	Número de segundos durante los cuales el candidato que se retiró de las primarias permanece inelegible para la reelección. Debe ser mayor que `0`.	`60`
período de recuperación secundaria en segundos	entero	Número de segundos que debe esperar un nodo secundario rezagado para ponerse al día antes de que el nodo primario baje. Debe ser mayor o igual que `0`. Si omite este campo, `mongod` aplicará su valor predeterminado.	Ninguno
expiraDespuésDeSegundos	entero	Número de segundos que la solicitud permanece en cola para que un agente de automatización la procese antes de que expire la tarea. Debe ser mayor que `0`.	`300`

Respuesta

Ops Manager devuelve 202 Accepted con un encabezado Location que apunta al punto final del trabajo de reelección get one y al documento del trabajo de reelección en el cuerpo de la respuesta.

Nombre	Tipo	Descripción
ID	string	Cadena única de dígitos hexadecimales 24 que identifica el trabajo 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 este trabajo. Devuelve `STEP_DOWN`.
replicaSetName	string	Nombre del conjunto de réplicas de destino.
Nombre del host	string	Nombre de host del proceso de destino.
Puerto	entero	Puerto del proceso objetivo.
Estado	string	Estado del trabajo. Devuelve uno de los siguientes valores: `QUEUED`, `RUNNING`, `COMPLETED`, `FAILED` o `EXPIRED`.
noOp	booleano	Indicador que especifica si la operación no tuvo efecto. Devuelve `true` si el proceso de destino ya era secundario cuando el agente ejecutó la tarea.
mensaje	string	Información detallada sobre el trabajo, legible para el usuario. El administrador de operaciones completa 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.
última actualización	string	Marca de tiempo, en formato ISO 8601 UTC, de la última vez que Ops Manager actualizó el trabajo.
expira	string	Marca de tiempo, en formato ISO 8601 UTC, después de la cual un agente de automatización deja de aceptar este trabajo.

Solicitud de ejemplo

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown?pretty=true" \
6      --data '{
7        "stepDownSecs": 60,
8        "secondaryCatchUpPeriodSecs": 10
9      }'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 202 Accepted
Vary: Accept-Encoding
Content-Type: application/json
Location: https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}
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

1 {
2   "id": "665a1234567890abcdef1234",
3   "groupId": "5c8100bcf2a30b12ff88258f",
4   "action": "STEP_DOWN",
5   "replicaSetName": "rs0",
6   "hostname": "node1.example.com",
7   "port": 27017,
8   "status": "QUEUED",
9   "noOp": false,
10   "message": null,
11   "created": "2026-08-11T05:37:59Z",
12   "lastUpdated": "2026-08-11T05:37:59Z",
13   "expires": "2026-08-11T05:42:59Z"
14 }

Códigos de respuesta

HTTP Status	Código de error	Descripción
202	--	Solicitud aceptada. Se devuelve el documento de solicitud de reelección.
400	INVALID_PARAMETER	Un parámetro sintonizable está fuera de rango o el cuerpo de la solicitud incluye `freezeSecs`.
400	AUTOMATION_AGENT_VERSION_NOT_SUPPORTED	El agente de automatización del host de destino es anterior a `109.0.0.9226-1`.
401	USUARIO NO AUTORIZADO	La clave API no tiene el rol `Project Automation Admin`.
401	EL USUARIO NO PUEDE ACCEDER A LA ORGANIZACIÓN	La persona que llama no pertenece a la organización del proyecto.
404	CONFIGURACIÓN DE AUTOMATIZACIÓN NO ENCONTRADA	El proyecto no tiene una configuración de automatización publicada.
404	CLÚSTER_NO_ENCONTRADO	`RS-ID` No coincide con ningún conjunto de réplicas en la implementación del proyecto.
404	PROCESO_NO_EN_CLÚSTER	`HOST-PORT` no pertenece al conjunto de réplicas mencionado.
409	AGENTE DE REELECCIÓN NO RESPONDE	El agente de automatización del host de destino no ha enviado ninguna señal al administrador de operaciones recientemente.
409	REELECCIÓN YA EN CURSO	Ya hay una tarea de reelección en cola o en ejecución para este conjunto de réplicas.

Volver

Empleos para la reelección

Mejora tu rendimiento en la secundaria

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/process/{HOST-PORT}:stepDown?pretty=true" \
6	--data '{
7	"stepDownSecs": 60,
8	"secondaryCatchUpPeriodSecs": 10
9	}'

1	{
2	"id": "665a1234567890abcdef1234",
3	"groupId": "5c8100bcf2a30b12ff88258f",
4	"action": "STEP_DOWN",
5	"replicaSetName": "rs0",
6	"hostname": "node1.example.com",
7	"port": 27017,
8	"status": "QUEUED",
9	"noOp": false,
10	"message": null,
11	"created": "2026-08-11T05:37:59Z",
12	"lastUpdated": "2026-08-11T05:37:59Z",
13	"expires": "2026-08-11T05:42:59Z"
14	}