Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

API de Gerenciamento do Ciclo de Vida de Processos

Você pode usar a API do Ops Manager para desligar, iniciar, reiniciar e ressincronizar um processo do MongoDB. Cada solicitação atualiza o processo na configuração de automação e publica a alteração imediatamente. O Agente de Automação do host de destino aplica a alteração em seu próximo check-in. Se o processo for o primário atual, o agente primeiro o desativa para que outro membro possa assumir o controle e, em seguida, o interrompe ou reinicia.

Each operation is asynchronous. A 200 OK response means Ops Manager published the change, not that the process has stopped, started, restarted, or resynced. The response includes no job ID. To follow the change to completion, poll the automation status resource. If the agent can't apply the change, the plan shows as failed there and the agent keeps retrying.

Every endpoint accepts an optional dryRun=true query parameter. Use it to preview a change before you apply it. Ops Manager runs all the same checks and returns the process document as it would look after the change, but sends nothing to the agent and changes nothing in your deployment. For example, after a shutdown the returned document contains "disabled": true. Review it, then send the same request without dryRun=true to apply the change.

Antes de utilizar os recursos do Ciclo de Vida do Processo, revise os seguintes requisitos.

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

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

To use the Process Lifecycle resources, you must be an Ops Manager user with the Project Automation Admin role.

Your deployment must run Ops Manager 8.0.28 or 9.0.2 or later. Automation must be enabled for the project, and the target host's Automation Agent must be running.

If you have an unpublished automation configuration draft in the project, Ops Manager rejects every request, including a dry run, with a 409 AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS error. Publish or discard the draft before you continue.

Todas as validações também se aplicam aos testes, portanto, um teste bem-sucedido prevê que a solicitação real passará pelas mesmas verificações. Uma solicitação real ainda pode falhar devido a uma alteração simultânea ou à validação em modo manual.

Importante

As operações do ciclo de vida do processo não são suportadas para projetos gerenciados externamente ou implantações do Kubernetes Operator (MCK).

Aviso

Esses endpoints não oferecem proteção de quorum. Desativar muitos membros de um conjunto de réplicas o deixa sem um primário. Desative os membros um de cada vez e aguarde a conclusão de cada um antes de prosseguir.

A tabela a seguir lista os endpoints disponíveis para o recurso Ciclo de Vida do Processo.

Método
Endpoint
Descrição

POST

Encerra corretamente um processo em execução.

POST

Inicia um processo que havia sido encerrado anteriormente.

POST

Reinicia um processo em execução de forma controlada.

POST

Aciona uma sincronização inicial em um membro do conjunto de réplicas.

Cada requisição bem-sucedida que não seja um teste adiciona um evento ao feed de atividades do projeto, além do evento de publicação da configuração de automação usual. O feed de atividades atribui as requisições feitas com a API à API Pública.

(operação)
Tipo de evento
O que ele diz a você

AUTOMATION_PROCESS_SHUTDOWN_REQUESTED

Foi feita uma solicitação de encerramento para este processo. Verifique este evento se um membro ficou offline inesperadamente.

AUTOMATION_PROCESS_STARTUP_REQUESTED

Foi feita uma solicitação para iniciar um processo que havia sido interrompido.

AUTOMATION_PROCESS_RESTART_REQUESTED

Foi feita uma solicitação de reinicialização para este processo. Verifique este evento se um membro se ausentou brevemente ou se ocorreu uma eleição.

AUTOMATION_PROCESS_RESYNC_REQUESTED

A resync request was made for this process. Check this event if a member went into STARTUP2 or RECOVERING and is re-copying data.