Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
资源
/
服务器使用情况

检索所有物理主机

在此页面上

  • 所需角色
  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

所需角色

此资源需要 API密钥才能具有 Global Owner角色。

Resource

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

GET /usage/groups

请求路径参数

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

请求查询参数

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

名称
类型
说明
默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

每页要返回的项目数，最多 500 个。

100

pretty

布尔

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

false

envelope

布尔

指示是否要将响应封装在信封中。

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

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

名称
说明

status

HTTP 响应代码

content

预期响应正文

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

无

请求正文参数

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

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称
类型
说明

results

阵列

数组为results 嵌入式文档 部分中详细介绍的每一项包含一个对象。

links

阵列

数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

totalCount

数字

结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。

results 嵌入式文档

结果数组中的每个元素都是一个物理主机。

响应元素
类型
说明

主机

对象数组

绑定到所提供物理主机的虚拟主机列表。

hosts
.[n].groupId

字符串

Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。

hosts
.[n].hostname

字符串

绑定到物理主机的虚拟主机的FQDN 。

id

字符串

Ops Manager 将虚拟主机绑定到的物理主机的唯一标识符。

名称

字符串

您为物理主机提供的标签。

serverType

字符串

物理主机的服务器类型。

Ops Manager 返回以下值之一：

  • DEV_SERVER

  • TEST_SERVER

  • 生产服务器

  • RAM_POOL

要学习；了解更多信息，请参阅MongoDB用法。

请求示例

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?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  "links": [
3    {
4      "href": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100",
5      "rel": "self"
6    }
7  ],
8  "results": [
9    {
10      "hosts": [
11        {
12          "groupId": "{projectId1}",
13          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7"
14        },
15        {
16          "groupId": "{projectId1}",
17          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8"
18        }
19      ],
20      "id": "{physicalHostId1}",
21      "name": "physicalHostA",
22      "serverType": "DEV_SERVER"
23    },
24    {
25      "hosts": [
26        {
27          "groupId": "{projectId2}",
28          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0"
29        },
30        {
31          "groupId": "{projectId2}",
32          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
33        }
34      ],
35      "id": "{physicalHostId2}",
36      "name": "physicalHostB",
37      "serverType": "DEV_SERVER"
38    },
39  ],
40  "totalCount": 2
41}

后退

生成使用情况快照

来年

检索一台物理主机