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.

Obter uma tarefa de eleição de conjunto de réplicas

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 este ponto de extremidade para recuperar uma única tarefa de reeleição pelo seu identificador exclusivo. Faça a sondagem deste ponto de extremidade até que a tarefa atinja um status terminal.

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

GET /groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}

A chave de API que faz esta solicitação deve ter a função Project Automation Admin.

Nome
Tipo
necessidade
Descrição

ID do grupo

string

Obrigatório

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

RS-ID

string

Obrigatório

Nome do conjunto de réplicas que contém a tarefa de reeleição.

ID-DA-TAREFA-DE-REELEIÇÃO

string

Obrigatório

String única de 24dígitos hexadecimais que identifica a tarefa de reeleição, conforme retornado pelo ponto de extremidade de redução ou aumento.

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.

A resposta retorna uma única tarefa de reeleição.

Nome
Tipo
Descrição

id

string

String única de 24dígitos hexadecimais que identifica a tarefa de reeleição.

groupId

string

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

ação

string

Ação que esta tarefa executa. Retorna um dos seguintes valores: STEP_DOWN ou STEP_UP.

ReplicaSetName

string

Nome do conjunto de réplicas de destino.

nome do host

string

Nome de host do processo de destino.

Porta

inteiro

Porta do processo de destino.

Status

string

Status da tarefa. Retorna um dos seguintes valores: QUEUED, RUNNING, COMPLETED, FAILED ou EXPIRED.

noop

booleano

Sinalizador que indica se a operação foi concluída como um no-op.

mensagem

string

Detalhes legíveis por humanos sobre a tarefa. O MongoDB Ops Manager preenche este campo após o agente relatar um resultado.

Criado

string

Timestamp, no formato ISO 8601 UTC, quando o Ops Manager criou o tarefa.

lastUpdated

string

Carimbo de data/hora, no formato ISO 8601 UTC, quando o MongoDB Ops Manager atualizou a tarefa pela última vez.

expira

string

Carimbo de data/hora, no formato ISO 8601 UTC, após o qual um agente de automação não seleciona mais esta tarefa.

Status
Terminal
Significado

NA FILA

No

O MongoDB Ops Manager criou a tarefa. Ele está aguardando que o agente de automação do hospedar de destino o identifique.

EM EXECUÇÃO

No

O agente está executando a tarefa.

concluído

Sim

A operação foi concluída. Verifique noOp para determinar se a operação fez uma alteração.

Falhou

Sim

A operação não pôde ser concluída. Consulte message para saber o motivo.

EXPIRADO

Sim

Nenhum agente assumiu a tarefa antes de expiresAfterSeconds decorridos.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}?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}
{ "id": "665a1234567890abcdef1234", "groupId": "5c8100bcf2a30b12ff88258f", "action": "STEP_UP", "replicaSetName": "rs0", "hostname": "node2.example.com", "port": 27017, "status": "COMPLETED", "noOp": false, "message": null, "created": "2026-08-11T05:37:59Z", "lastUpdated": "2026-08-11T05:38:45Z", "expires": "2026-08-11T05:39:59Z"}
HTTP Status
Código de erro
Descrição

200

--

Retorna o documento da tarefa de reeleição.

401

USER_UNAUTHORIZED

A chave de API não tem a função Project Automation Admin.

404

TRABALHO_DE_REELEIÇÃO_NÃO_ENCONTRADO

REELECTION-JOB-ID é desconhecido ou está malformado, ou a tarefa não pertence ao conjunto de réplicas nomeado em RS-ID.