Obter uma tarefa de reeleição do 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 esse endpoint para recuperar uma única tarefa de reeleição por seu identificador exclusivo. Pesquise esse endpoint até que o tarefa atinja um status de terminal.

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

Resource

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

Funções obrigatórias

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

Parâmetros do caminho da solicitação

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 o tarefa de reeleição.
REELECTION-JOB-ID	string	Obrigatório	String exclusiva de 24 dígitos hexadecimais que identifica o tarefa de reeleição, conforme retornado pelo endpoint de step down ou step up.

Solicitar parâmetros de query

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

Nome	Tipo	necessidade	Descrição	Default
pretty	booleano	Opcional	Flag indicating whether the response body is in a prettyprint format.	`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`

Parâmetros do corpo da solicitação

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

Resposta

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

Nome	Tipo	Descrição
id	string	String única de 24 dí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 este 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 gerente de operações preenche este campo depois que o agente relata um resultado.
Criado	string	Timestamp, no formato ISO 8601 UTC, quando o Ops Manager criou o tarefa.
lastUpdated	string	Timestamp, no formato ISO 8601 UTC, quando o Ops Manager atualizou pela última vez o tarefa.
expira	string	Timestamp, no formato ISO 8601 UTC, após o qual um agente de automação não pega mais essa tarefa.

Valores de status da tarefa

Status	Terminal	Significado
FILA	No	O gerente de operações criou o tarefa. Ele está esperando que o agente de automação do host de destino o busque.
CORRENDO	No	O agente está executando o tarefa.
CONCLUÍDO	Sim	A operação foi concluída. Verifique `noOp` para determinar se a operação fez uma alteração.
Falhou	Sim	Não foi possível concluir a operação. Consulte `message` para saber o motivo.
Expirado	Sim	Nenhum agente escolheu a tarefa antes de `expiresAfterSeconds` decorrido.

Exemplo de solicitação

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

1 {
2   "id": "665a1234567890abcdef1234",
3   "groupId": "5c8100bcf2a30b12ff88258f",
4   "action": "STEP_UP",
5   "replicaSetName": "rs0",
6   "hostname": "node2.example.com",
7   "port": 27017,
8   "status": "COMPLETED",
9   "noOp": false,
10   "message": null,
11   "created": "2026-08-11T05:37:59Z",
12   "lastUpdated": "2026-08-11T05:38:45Z",
13   "expires": "2026-08-11T05:39:59Z"
14 }

Códigos de resposta

HTTP Status	Código de erro	Descrição
200	--	Retorna o documento do tarefa de reeleição.
401	USER_UNAUThorIZED	A chave de API não tem o role `Project Automation Admin`.
404	REELECTION_JOB_NOT_FOUND	`REELECTION-JOB-ID` é desconhecido ou malformado, ou o tarefa não pertence ao conjunto de réplicas nomeado em `RS-ID`.

Voltar

Intensifique um secundário

Obter todos

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}?pretty=true"

1	{
2	"id": "665a1234567890abcdef1234",
3	"groupId": "5c8100bcf2a30b12ff88258f",
4	"action": "STEP_UP",
5	"replicaSetName": "rs0",
6	"hostname": "node2.example.com",
7	"port": 27017,
8	"status": "COMPLETED",
9	"noOp": false,
10	"message": null,
11	"created": "2026-08-11T05:37:59Z",
12	"lastUpdated": "2026-08-11T05:38:45Z",
13	"expires": "2026-08-11T05:39:59Z"
14	}