所需角色
此资源需要API 密钥才能具有Global Owner角色。
Resource
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /usage/groups/{physicalHostId}请求路径参数
Ops Manager 需要所有请求路径参数：
路径参数 | 类型 | 说明 |
|---|---|---|
物理主机 ID | 字符串 | 物理托管的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 说明 | 默认 |
|---|---|---|---|
pageNum | 整型 | 页码（从 1 开始）。 |
|
itemsPerPage | 整型 | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | 指示显示正文是否应采用 prettyprint 格式。 |
|
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回一个结果的终结点，响应体包括：
对于返回结果列表的端点， | 无 |
请求正文参数
正文参数 | 类型 | 必要性 | 说明 |
|---|---|---|---|
虚拟主机 | 字符串数组 | 必需 | 绑定到所提供物理主机的虚拟主机列表。 |
virtualHosts | 字符串 | Optional | Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。 |
virtualHosts | 字符串 | Optional | 绑定到物理主机的虚拟主机的FQDN 。 |
名称 | 字符串 | 必需 | 您为物理主机提供的标签。 此值必须是唯一的。 |
serverType | 字符串 | 必需 | 物理主机的服务器类型。 您可以将其设置为以下值之一：
要学习；了解更多信息，请参阅MongoDB使用页面。 |
响应
响应元素 | 类型 | 说明 |
|---|---|---|
主机 | 对象数组 | 绑定到所提供物理主机的虚拟主机列表。 |
hosts | 字符串 | Ops Manager 将此虚拟主机置于其中的项目的唯一标识符。 |
hosts | 字符串 | 绑定到物理主机的虚拟主机的FQDN 。 |
id | 字符串 | Ops Manager 将虚拟主机绑定到的物理主机的唯一标识符。 |
名称 | 字符串 | 您为物理主机提供的标签。 |
serverType | 字符串 |
请求示例
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{groupId}?pretty=true" \ --data '{ "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", }, "virtualHosts": [ { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", "groupId": "{groupId}" } ] }'响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "hosts": [ { "groupId": "{groupId}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" } ], "id": "{physicalHostID}", "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", },}