Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ /

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例

资源是 Ops Manager API 的点。从这里开始,您可以遍历 links以访问所有其他 API 资源。

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

GET /

此端点不使用 HTTP 请求路径参数。

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

名称
类型
必要性
说明
默认
pageNum
数字
Optional
从一开始的整数,用于返回结果的一部分。
1
itemsPerPage
数字
Optional
每页要返回的项目数,最多 500 个。
100
pretty
布尔
Optional
指示响应正文是否应采用 prettyprint 格式 的标志 格式。
false
envelope
布尔
Optional

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

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 envelope : true

对于返回结果列表的端点, results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false
backupJobsEnabledOnly
布尔
Optional
指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。
true

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

响应包括:

名称
类型
说明
appName
字符串
MongoDB Ops Manager
构建
字符串
与 Ops Manager 的 GitHub 提交相对应的 SHA。
链接
对象数组

指向子资源和/或相关资源的一个或多个链接。 响应中的所有links数组至少包含一个名为self的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

节流
布尔
该字段已过时,值为false
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "<ops-manager-host>:<port>/api/public/v1.0"
{
"appName" : "MongoDB Ops Manager",
"build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
"links" : [
],
"throttling" : false
}

后退

Ops Manager Administration API 资源