注意
注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。终结点仍如文档中所述。
使用此终结点通过唯一标识符检索单个重新选举作业。轮询此终结点,直到作业达到终端状态。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/replicaSets/{RS-ID}/reElectionJobs/{REELECTION-JOB-ID}所需角色
发出此请求的 API 密钥必须具有 Project Automation Admin 角色。
请求路径参数
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
群组 ID(group ID) | 字符串 | 必需 | 标识项目的唯一 24 位十六进制数字字符串。 |
RS-ID | 字符串 | 必需 | 包含重新选举作业的副本集的名称。 |
REELECTION-作业-ID | 字符串 | 必需 | 唯一的 24 位十六进制数字 string,用于标识重新选举作业,由降级或升级终结点返回。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否采用 pretty-print 格式的标志。 |
|
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。 对于返回一个结果的端点,响应体包括:
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应返回单个重新选举作业。
名称 | 类型 | 说明 |
|---|---|---|
id | 字符串 | 用于标识重新选举作业的唯一 24 位十六进制数字 string。 |
groupId | 字符串 | 用于标识项目的唯一的 24 位十六进制数字字符串。 |
操作 | 字符串 | 此作业执行的操作。返回以下值之一: |
ReplicaSetName | 字符串 | 目标副本集的名称。 |
主机名 | 字符串 | 目标进程的主机名。 |
端口 | 整型 | 目标进程的端口。 |
状态 | 字符串 | 作业的状态。返回以下值之一: |
noop | 布尔 | 指示操作是否作为无操作 (no-op) 完成的标志。 |
message | 字符串 | 关于该作业的人类可读详细信息。代理报告结果后,MongoDB Ops Manager 会填充此字段。 |
已创建 | 字符串 | Ops Manager创建作业的时间戳,采用 ISO 8601 UTC 格式。 |
最后更新 | 字符串 | MongoDB Ops Manager 最后更新作业的时间戳(ISO 8601 UTC 格式)。 |
expires | 字符串 | ISO 8601 UTC 格式的时间戳,在此时间之后,自动化代理将不再执行此作业。 |
作业状态值
状态 | 终端 | 含义 |
|---|---|---|
已排队 | No | Ops Manager 创建了该作业。它正在等待目标托管的自动化代理来获取它。 |
正在运行 | No | 代理正在运行该作业。 |
completed | 是 | 操作已完成。检查 |
已失败 | 是 | 操作无法完成。有关原因,请参阅 |
已过期 | 是 | 在 |
请求示例
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-aliveHTTP/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 | 错误代码 | 说明 |
|---|---|---|
200 | -- | 返回重新选举作业文档。 |
401 | 用户未授权 | 该 API 密钥没有 |
404 | REELECTION_JOB_NOT_FOUND |
|