/ /

Implantações

Trabalhos de reeleição

Página inicial do Docs

Gestão

Trabalhos de reeleição

Obter todas as tarefas 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 cada tarefa de reeleição para um conjunto de réplicas específico.

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

Resource

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

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 cujos trabalhos de reeleição você deseja listar.

Solicitar parâmetros de query

Nome	Tipo	Descrição	Default
pageNum	inteiro	Número da página (com base em índice 1).	`1`
itemsPerPage	inteiro	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Indica se o corpo da resposta deve estar em formato prettyprint.	`false`
envelope	booleano	Indica se deseja ou não 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 consulta. Para endpoints que retornam um resultado, o corpo da resposta inclui: `status`: Código de resposta HTTP `content`: Corpo de resposta esperado Para endpoints que retornam uma lista de resultados, o objeto `results` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	none

Parâmetros do corpo da solicitação

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

Resposta

A resposta inclui uma array de objetos de tarefa de reeleição e o número total de objetos de tarefa recuperados.

Nome	Tipo	Descrição
Resultados	array	Array de trabalhos de reeleição, classificados dos criados mais recentemente para os criados menos recentemente. Consulte `results` documento incorporado.
contagem total	número	Número total de itens no conjunto de resultados. Isso pode exceder o número de itens em `results` quando a resposta é paginada.

`results` documento incorporado

Cada elemento de results representa um 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.

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?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   "results": [
3     {
4       "id": "665a1234567890abcdef5678",
5       "groupId": "5c8100bcf2a30b12ff88258f",
6       "action": "STEP_UP",
7       "replicaSetName": "rs0",
8       "hostname": "node2.example.com",
9       "port": 27017,
10       "status": "COMPLETED",
11       "noOp": false,
12       "message": null,
13       "created": "2026-08-11T05:40:00Z",
14       "lastUpdated": "2026-08-11T05:41:15Z",
15       "expires": "2026-08-11T05:45:00Z"
16     },
17     {
18       "id": "665a1234567890abcdef1234",
19       "groupId": "5c8100bcf2a30b12ff88258f",
20       "action": "STEP_DOWN",
21       "replicaSetName": "rs0",
22       "hostname": "node1.example.com",
23       "port": 27017,
24       "status": "COMPLETED",
25       "noOp": false,
26       "message": null,
27       "created": "2026-08-11T05:37:59Z",
28       "lastUpdated": "2026-08-11T05:38:30Z",
29       "expires": "2026-08-11T05:42:59Z"
30     }
31   ],
32   "totalCount": 2
33 }

Códigos de resposta

HTTP Status	Código de erro	Descrição
200	--	Retorna a array de trabalhos de reeleição.
401	USER_UNAUThorIZED	A chave de API não tem o role `Project Automation Admin`.

Voltar

Pegue um

Agentes

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?pretty=true"

1	{
2	"results": [
3	{
4	"id": "665a1234567890abcdef5678",
5	"groupId": "5c8100bcf2a30b12ff88258f",
6	"action": "STEP_UP",
7	"replicaSetName": "rs0",
8	"hostname": "node2.example.com",
9	"port": 27017,
10	"status": "COMPLETED",
11	"noOp": false,
12	"message": null,
13	"created": "2026-08-11T05:40:00Z",
14	"lastUpdated": "2026-08-11T05:41:15Z",
15	"expires": "2026-08-11T05:45:00Z"
16	},
17	{
18	"id": "665a1234567890abcdef1234",
19	"groupId": "5c8100bcf2a30b12ff88258f",
20	"action": "STEP_DOWN",
21	"replicaSetName": "rs0",
22	"hostname": "node1.example.com",
23	"port": 27017,
24	"status": "COMPLETED",
25	"noOp": false,
26	"message": null,
27	"created": "2026-08-11T05:37:59Z",
28	"lastUpdated": "2026-08-11T05:38:30Z",
29	"expires": "2026-08-11T05:42:59Z"
30	}
31	],
32	"totalCount": 2
33	}