创建一个物理主机

在此页面上

所需角色

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

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

所需角色

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

Resource

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

POST /usage/groups

请求路径参数

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

请求查询参数

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

名称

类型

说明

默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

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

100

pretty

布尔

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

false

envelope

布尔

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

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

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

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

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

无

请求正文参数

正文参数	类型	必要性	说明
虚拟主机	字符串数组	必需	绑定到所提供物理主机的虚拟主机列表。
virtualHosts .groupId	字符串	Optional	Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。
virtualHosts .hostname	字符串	Optional	绑定到物理主机的虚拟主机的FQDN 。
名称	字符串	必需	您为物理主机提供的标签。此值必须是唯一的。
serverType	字符串	必需	物理主机的服务器类型。您可以将其设置为以下值之一： `DEV_SERVER` `TEST_SERVER` `PRODUCTION_SERVER` `RAM_POOL` 要学习；了解更多信息，请参阅MongoDB用法。

响应

响应元素	类型	说明
主机	对象数组	绑定到所提供物理主机的虚拟主机列表。
hosts .[n].groupId	字符串	Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。
hosts .[n].hostname	字符串	绑定到物理主机的虚拟主机的FQDN 。
id	字符串	Ops Manager 将虚拟主机绑定到的物理主机的唯一标识符。
名称	字符串	您为物理主机提供的标签。
serverType	字符串	物理主机的服务器类型。 Ops Manager 返回以下值之一： DEV_SERVER TEST_SERVER 生产服务器 RAM_POOL 要学习；了解更多信息，请参阅MongoDB用法。

请求示例

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6      --data '{
7                "name": "physicalHostA",
8                "serverType":
9                  {
10                    "name": "PRODUCTION_SERVER",
11                    "label": "Production Server",
12                  },
13                "virtualHosts": [
14                  {
15                    "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16                    "groupId": "{groupId}"
17                  }
18                ]
19              }'

响应示例

响应标头

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": "{groupId}",
5       "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6     }
7   ],
8   "id": "{physicalHostID}",
9   "name": "physicalHostA",
10   "serverType":
11     {
12       "name": "PRODUCTION_SERVER",
13       "label": "Production Server",
14     },
15 }

后退

检索一台物理主机

来年

更新一台物理主机

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6	--data '{
7	"name": "physicalHostA",
8	"serverType":
9	{
10	"name": "PRODUCTION_SERVER",
11	"label": "Production Server",
12	},
13	"virtualHosts": [
14	{
15	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16	"groupId": "{groupId}"
17	}
18	]
19	}'

1	{
2	"hosts": [
3	{
4	"groupId": "{groupId}",
5	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6	}
7	],
8	"id": "{physicalHostID}",
9	"name": "physicalHostA",
10	"serverType":
11	{
12	"name": "PRODUCTION_SERVER",
13	"label": "Production Server",
14	},
15	}