Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API 资源
/
MongoDB Server 使用情况

检索一台物理主机

在此页面上

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

所需角色

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

Resource

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

GET /usage/groups/{physicalHostId}

请求路径参数

Ops Manager 需要所有请求路径参数：

路径参数
类型
说明
物理主机 ID
字符串
要检索的物理主机的唯一标识符。

请求查询参数

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

名称
类型
说明
默认
pageNum
整型
页码（从 1 开始）。
1
itemsPerPage
整型
每页要返回的项目数，最多 500 个。
100
pretty
布尔
指示响应正文是否应采用 prettyprint 格式。
false
envelope
布尔

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

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

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

状态
HTTP 响应代码
envelope
预期响应正文

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

无

请求正文参数

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

响应

响应元素
类型
说明
主机
对象数组
绑定到所提供物理主机的虚拟主机列表。
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     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{physicalHostId}?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  "hosts": [
3    {
4      "groupId": "{PROJECT-ID}",
5      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-2"
6    },
7    {
8      "groupId": "{PROJECT-ID}",
9      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-3"
10    },
11    {
12      "groupId": "{PROJECT-ID}",
13      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-4"
14    },
15    {
16      "groupId": "{PROJECT-ID}",
17      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-5"
18    },
19    {
20      "groupId": "{PROJECT-ID}",
21      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-6"
22    },
23    {
24      "groupId": "{PROJECT-ID}",
25      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-7"
26    },
27    {
28      "groupId": "{PROJECT-ID}",
29      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-8"
30    },
31    {
32      "groupId": "{PROJECT-ID}",
33      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-9"
34    }
35  ],
36  "id": "{PHYSICAL-HOST-ID}",
37  "name": "physicalDevHostA",
38  "serverType": "DEV_SERVER"
39}

后退

检索所有物理主机

来年

创建一个物理主机