Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Resources
/
Server Usage

Retrieve One Physical Host

On this page

  • Required Roles
  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

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

GET /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 retrieved.

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 "envelope" : true in the query.

For endpoints that return one result, response body includes:

Name
Description

status

HTTP response code

content

Expected response body

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

None

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

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:

  • DEV_SERVER

  • TEST_SERVER

  • PRODUCTION_SERVER

  • RAM_POOL

To learn more, see MongoDB Usage.

Example Request

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"

Example Response

Response Header

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}

Response Body

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}

Back

Retrieve All Physical Hosts

Next

Create Physical Host