Descripción
Pausa la operación de sincronización actual.
Requisito
Para utilizar el punto final pause, mongosync debe estar en el EstadoEN EJECUCIÓN.
Nota
Cuando configures múltiples instancias de mongosync para sincronizarse entre clústeres fragmentados, debes enviar comandos idénticos de puntos finales API a cada instancia de mongosync.
Para obtener más información, consultar Pausar múltiples Mongosyncs.
Solicitud
POST /api/v1/pause
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros del cuerpo de la solicitud HTTP. Sin embargo, debes especificar la opción --data con un objeto vacío { }.
Respuesta
Campo | Tipo | Descripción |
|---|---|---|
| booleano | Cuando la solicitud es exitosa, este valor es |
| string | Si se produce un error, se indicará el nombre del error. Este campo se omite de la respuesta cuando |
| string | Descripción detallada del error ocurrido. Este campo se omite en la respuesta cuando |
Ejemplo
El siguiente ejemplo pausa la operación de sincronización actual.
Solicitud
curl localhost:27182/api/v1/pause -XPOST --data '{ }'
Respuesta
{"success":true}
Comportamiento
Si la solicitud
pausees exitosa,mongosyncingresa al estadoPAUSED.Si planeas pausar la sincronización durante un periodo prolongado, aumenta el tamaño del set de réplicas oplog en el clúster de origen. Para obtener más información, consulte Preguntas frecuentes.
Para más información sobre el estado PAUSED, consulte comportamiento de sincronización pausada.
Protección de endpoints
mongosync no protege el punto de conexión pause. Sin embargo, por defecto, la API se vincula únicamente a localhost y no acepta llamadas de otras fuentes. Además, la llamada pause no expone credenciales de conexión ni datos de usuario.