Update One Physical Host
On this page
Required Roles
This resource requires the
API Key to have
the Global Owner
role.
Resource
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /usage/groups/{physicalHostId}
Request Path Parameters
Ops Manager requires all request path parameters:
Path Parameter | Type | Description |
---|---|---|
physicalHostId | string | Unique identifier of the physical host to be removed. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Description | Default | ||||
---|---|---|---|---|---|---|---|
pageNum | integer | Page number (1-index based). | 1 | ||||
itemsPerPage | integer | Number of items to return per page, up to a maximum of 500. | 100 | ||||
pretty | boolean | Indicates whether the response body should be in a
prettyprint format. | false | ||||
envelope | boolean | Indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, response body includes:
For endpoints that return a list of results, the | None |
Request Body Parameters
Body Parameter | Type | Necessity | Description |
---|---|---|---|
virtualHosts | array of strings | Required | List of virtual hosts bound to the provided physical host. |
virtualHosts .groupId | string | Optional | Unique identifier of the project into which Ops Manager places this
virtual host. |
virtualHosts .hostname | string | Optional | FQDN of the virtual host bound to the physical host. |
name | string | Required | Label you gave to the physical host. This value must be unique. |
serverType | string | Required | Server Type of the physical host. You can set this to one of the following values:
To learn more, see MongoDB Usage. |
Response
Response Element | Type | Description |
---|---|---|
hosts | array of objects | List of virtual hosts bound to the provided physical host. |
hosts .[n].groupId | string | Unique identifier of the project into which Ops Manager places this
virtual host. |
hosts .[n].hostname | string | FQDN of the virtual host bound to the physical host. |
id | string | Unique identifier of the physical host to which Ops Manager bound
the virtual hosts. |
name | string | Label you gave to the physical host. |
serverType | string | Server Type of the physical host. Ops Manager returns one of the following values:
To learn more, see MongoDB Usage. |
Example Request
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups/{groupId}?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 }'
Example Response
Response Header
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
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}
Response Body
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 }