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.

Encerrar um processo com a API pública

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.

Use this endpoint to gracefully stop a running process. Ops Manager sets disabled to true for the process in the automation configuration and publishes the change. If the process is the current primary, the Automation Agent steps it down before it stops the process.

The request is asynchronous: 200 OK means Ops Manager published the change, not that the process has stopped. Poll the automation status resource until the process's lastGoalVersionAchieved equals the plan's goalVersion.

Se o processo já estiver encerrado, nada muda e o agente não executa nenhuma ação, mas o Ops Manager ainda publica a configuração e registra o evento.

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

POST /groups/{GROUP-ID}/process/{HOST-PORT}:shutdown

The API key that makes this request must have the Project Automation Admin role.

Nome
Tipo
necessidade
Descrição

ID do grupo

string

Obrigatório

String única de 24 dígitos hexadecimais que identifica seu projeto.

hospedar-PORTA

string

Obrigatório

Target process, as hostname:port. For example, node1.example.com:27017.

Nome
Tipo
necessidade
Descrição
Default

execução seca

booleano

Opcional

If true, Ops Manager validates the request and returns the changed process without publishing it or adding an activity feed event. Ops Manager rejects any value other than true or false with 400 INVALID_QUERY_PARAMETER.

false

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Ops Manager returns 200 OK and the target process as it appears in the automation configuration, with the change applied. disabled is true. The body is the same whether you set dryRun or not.

Nome
Tipo
Descrição

name

string

Nome do processo na configuração de automação.

nome do host

string

Nome do host do processo.

tipoDeProcesso

string

Type of process, for example mongod.

Versão

string

Versão do processo em MongoDB.

desabilitado

booleano

true se o processo for encerrado.

lastRestart

string

Timestamp, in ISO 8601 UTC format, of the last requested restart.

lastResync

string

Timestamp, in ISO 8601 UTC format, of the last requested resync.

The document also contains the rest of the process's automation configuration, such as args2_6, featureCompatibilityVersion, and authSchemaVersion. See the Automation Configuration reference.

The following example shuts down the process running on node1.example.com:27017.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/process/node1.example.com:27017:shutdown?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "name": "rs0_1", "processType": "mongod", "version": "8.0.4", "hostname": "node1.example.com", "disabled": true, "authSchemaVersion": 5, "featureCompatibilityVersion": "8.0", "args2_6": { "net": { "port": 27017 }, "replication": { "replSetName": "rs0" }, "storage": { "dbPath": "/data/rs0_1" }, "systemLog": { "destination": "file", "path": "/data/rs0_1/mongodb.log" } }}
HTTP Status
Código de erro
Descrição

200

--

The change was published, or computed with dryRun=true. Returns the process document.

400

--

O processo está em modo manual ou a validação da configuração de automação falhou. A mensagem explica o motivo. Não foi possível realizar uma simulação.

409

GRUPO_EM_MODO_DE_RESTAURAÇÃO

O projeto está se reconciliando após uma restauração.

403

PROCESS_EXTERNALLY_GERAGED

Os processos do projeto são gerenciados por um sistema externo.

409

AUTOMATION_CONFIG_DRAFT_ALREADY_EXISTS

Você tem um rascunho de configuração de automação não publicado no projeto.

404

PROCESSO NÃO ENCONTRADO

HOST-PORT Não corresponde a nenhum processo na configuração de automação do projeto.

400

PARÂMETRO_DE_CONSULTA_INVÁLIDO

dryRun isn't true or false.

409

AUTOMATION_CONFIG_CONCURRENT_MODIFICATION

Alguém publicou uma alteração enquanto esta solicitação estava em andamento. O Ops Manager retorna este código apenas para uma solicitação real.

O Ops Manager verifica os erros compartilhados na ordem listada. Consulte o Ciclo de Vida do Processo para obter informações sobre pré-requisitos e limitações.