对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

获取最新计划的自动化状态

注意

注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。终结点仍如文档中所述。

检索 MongoDB 进程的最新计划。 计划是将 MongoDB 部署到goalVersion所需的一组操作。

端点返回goalVersion字段以报告自动化配置的当前版本,并返回lastGoalVersionAchieved字段以报告每台服务器上运行的配置版本。

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

GET /groups/{PROJECT-ID}/automationStatus
Parameter
类型
说明

PROJECT-ID

字符串

(必需。) 项目的唯一标识符。

以下查询参数为可选参数:

名称
类型
必要性
说明
默认

pretty

布尔

Optional

指示响应正文是否采用 prettyprint 格式的标记。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true。

对于返回一个结果的端点,响应体包括:

  • status: HTTP响应代码

  • content:预期响应正文

false

此端点不使用 HTTP 请求正文参数。

名称
类型
说明

targetVersion

数字

最近提交的自动化配置的版本。 如果在提交自动化配置时出现冲突,则此字段会列出获胜的配置。

processes

阵列

项目已部署的 MongoDB 实例。

process.errorCode

整型

错误代码。 如果该进程没有错误,则返回0 。

process.errorCodeDescription

字符串

详细的错误描述。 如果进程没有错误,则返回空字符串。

process.errorCodeHumanReadable

字符串

简短的错误描述。 如果进程没有错误,则返回空字符串。

process.errorString

字符串

包含错误的日志行的输出。 检查此字段以获取其他错误上下文。 如果进程没有错误,则返回空字符串。

processes.hostname

字符串

托管 MongoDB 进程和自动化的服务器的完全限定域名(通过发出hostname -f检索)。

processes.name

字符串

自动化配置中指定的进程名称。

processes.lastGoalVersionAchieved

数字

此流程已按配置部署的最新自动化配置版本。 如果processes.lastGoalVersionAchieved数字不等于goalVersion数字,则根据当前配置,该进程尚未部署。

processes.plan

阵列

描述尚未更新配置的进程如何实现目标状态。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/automationStatus"
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}
{
"goalVersion": 11,
"processes": [{
"errorCode": 0,
"errorCodeDescription": "",
"errorCodeHumanReadable": "",
"errorString": "",
"hostname": "example.net",
"lastGoalVersionAchieved": 11,
"name": "myReplicaSet_3",
"plan": ["Download",
"WaitRsInit",
"WaitFeatureCompatibilityVersionCorrect"
]
}, {
"errorCode": 100,
"errorCodeDescription": "There is an issue with file permissions for this process",
"errorCodeHumanReadable": "File Permissions Error",
"errorString": "<myReplicaSet_1> [13:11:33.348] Failed to compute states : <myReplicaSet_1> [13:11:33.348] Error calling ComputeState : <myReplicaSet_1> [13:11:33.348] Error getting fickle state for current state : <myReplicaSet_1> [13:11:33.348] Error checking if process is running from dbpath = /data/0 : <myReplicaSet_1> [13:11:33.348] Error getting file contents of /data/0/mongod.lock as string : <myReplicaSet_1> [13:11:33.348] Error reading file from /data/0/mongod.lock : open /data/0/mongod.lock: permission denied",
"hostname": "example.net",
"lastGoalVersionAchieved": 1,
"name": "myReplicaSet_1",
"plan": ["Download"]
}, {
"errorCode": 0,
"errorCodeDescription": "",
"errorCodeHumanReadable": "",
"errorString": "",
"hostname": "example.net",
"lastGoalVersionAchieved": 11,
"name": "myReplicaSet_2",
"plan": ["WaitRsInit",
"WaitFeatureCompatibilityVersionCorrect"
]
}]
}