检索一个项目的所有代理版本

在此页面上

所需角色

请求
请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

所需角色

您可以使用以下任何分配的角色成功调用此端点：

Project Read Only

请求

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

GET /groups/{PROJECT-ID}/agents/versions

请求路径参数

名称	类型	必要性	说明
`PROJECT-ID`	字符串	必需	项目的唯一标识符。

请求查询参数

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

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

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

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

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

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

响应

名称	类型	说明
`count`	整型	Ops Manager 应用程序已找到的代理数量。
`entries`	对象数组	有关此 Ops Manager 应用程序托管的每台主机上每个代理的详细信息。
`entries` `.address`	字符串	运行此代理的主机的 IPv6 地址。
`entries` `.hostname`	字符串	运行此代理的主机的FQDN 。
`entries` `.hostnameShort`	字符串	运行此代理的主机名。
`entries` `.version`	字符串	该主机运行的助手的版本。
`entries` `.pingCount`	整型	从该代理收到的 ping 计数。
`entries` `.confCount`	整型	从该代理收到的配置调用计数。
`entries` `.tagName`	字符串	如果启用了备份，则为该代理添加标签。
`entries` `.lastPing`	数字	自 UNIX 纪元以来经过的时间戳（以毫秒为单位）MongoDB Ops Manager 从该代理收到最后一次网络探测（ping）的时间。适用于监控代理和已启用监控的 MongoDB 助手。
`entries` `.lastConf`	数字	自 UNIX 纪元以来经过的时间戳（以毫秒为单位）MongoDB Ops Manager 从该代理收到最后一次配置调用的时间。
`entries` `.msSinceLastConf`	数字	自上次配置调用以来经过的毫秒数。
`entries` `.isPrimary`	布尔	指示运行此助手的主机是否为主节点的标志。
`entries` `.isManaged`	布尔	指示 Ops Manager 是否托管此代理的标志。仅适用于监控和备份代理。
`entries` `.numProcess`	整型	在此主机上运行的 MongoDB 进程数。
`entries` `.isVersionOld`	布尔	指示已安装的代理已过时的标志。此代理的当前发布版本超过了已安装代理的版本。
`entries` `.isVersionDeprecated`	布尔	指示此代理已弃用的标志。此代理支持的最低版本超过已安装代理的版本。
`entries` `.pingState`	字符串	此代理的当前状态。 `pingName`返回以下值之一： `ok` `warning` `error`
`entries` `.isModule`	布尔	指示此条目是 MongoDB Agent 模块的标志。
`isAnyAgentNotManaged`	布尔	指示是否有任何代理在处于非托管状态的主机上运行的标志。
`isAnyAgentVersionDeprecated`	布尔	指示任何部署中的任何代理是否运行该代理的已弃用版本的标志。
`isAnyAgentVersionOld`	布尔	指示任何部署中是否有任何代理运行的不是当前版本的标志。
`latestVersion`	字符串	此类代理的最新版本。
`links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`minimumAgentVersionDetected`	字符串	此主机上安装的此代理受支持的最低版本。
`minimumVersion`	字符串	与 Ops Manager 安装配合使用的此代理的最低支持版本。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/versions?pretty=true"

响应示例

响应标头

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}

响应体

1 {
2   "count": 0,
3   "entries": [],
4   "isAnyAgentNotManaged": false,
5   "isAnyAgentVersionDeprecated": false,
6   "isAnyAgentVersionOld": false,
7   "latestVersion": "10.14.0.6304",
8   "links": [{
9       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current",
10       "rel": "self"
11     },
12     {
13       "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}",
14       "rel": "http://mms.mongodb.com/group"
15     }
16   ],
17   "minimumAgentVersionDetected": "10.14.0.6304",
18   "minimumVersion": "5.0.0.309"
19 }

后退

检索所有代理版本

来年

创建一个代理 API 密钥

1	{
2	"count": 0,
3	"entries": [],
4	"isAnyAgentNotManaged": false,
5	"isAnyAgentVersionDeprecated": false,
6	"isAnyAgentVersionOld": false,
7	"latestVersion": "10.14.0.6304",
8	"links": [{
9	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current",
10	"rel": "self"
11	},
12	{
13	"href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}",
14	"rel": "http://mms.mongodb.com/group"
15	}
16	],
17	"minimumAgentVersionDetected": "10.14.0.6304",
18	"minimumVersion": "5.0.0.309"
19	}