pause
Nesta página
Descrição
Pausa a operação de sincronização atual.
Requerimento
Para usar o endpoint pause , mongosync deve estar no estado RUNNING .
Observação
Ao configurar várias instâncias mongosync para sincronizar entre clusters fragmentados, você deve enviar comandos de ponto de conexão da API idênticos para cada instância mongosync .
Para obter mais informações, consulte Pausar vários Mongosyncs.
Solicitar
POST /api/v1/pause
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP. No entanto, você deve especificar a opção --data com um objeto vazio { }.
Resposta
Campo | Tipo | Descrição |
|---|---|---|
| booleano | Quando a solicitação é bem-sucedida, esse valor é |
| string | Se ocorreu um erro, indica o nome do erro. Este campo é omitido da resposta quando |
| string | Descrição detalhada do erro que ocorreu. Este campo é omitido da resposta quando |
Exemplo
O exemplo a seguir pausa a operação de sincronização atual.
Solicitar
curl localhost:27182/api/v1/pause -XPOST --data '{ }'
Resposta
{"success":true}
Comportamento
Se a solicitação
pausefor bem-sucedida,mongosyncentrará no estadoPAUSED.Se você planeja pausar a sincronização por um longo período de tempo, aumente o tamanho do oplog do conjunto de réplicas no cluster de origem. Para saber mais, consulte Perguntas frequentes.
Para obter mais informações sobre o PAUSED estado, consulte Comportamento de sincronização pausada.
Proteção de endpoint
mongosync não protege o endpoint pause . No entanto, por padrão, a API é vinculada apenas ao host local e não aceita chamadas de outras fontes. Além disso, a chamada pause não expõe credenciais de conexão ou dados de usuário.