Get Host by ID
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Get the MongoDB process with the specified host ID.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}
Request Path Parameters
Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier of the project that owns this MongoDB process. |
HOST-ID | string | Required | Unique identifier of the host for the MongoDB process. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag that 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, the response body includes:
| false |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
---|---|---|
aliases | array of strings | Array of alternate hostname and port combinations that Ops Manager
discovered for the MongoDB process. These combinations can
include hostnames, FQDNs, IPv4 addresses, and IPv6
addresses. |
alertsEnabled | boolean | true if this MongoDB process has alerts enabled. |
authMechanismName | string | Authentication mechanism used to connect to this MongoDB process. This displays only one of the following values:
|
clusterId | string | Unique identifier of the cluster to which the MongoDB
process belongs. |
created | date | Date Ops Manager created or first discovered this MongoDB process. |
groupId | string | Unique identifier of the group that owns this host. |
hasStartupWarnings | boolean | true if this MongoDB process had startup warnings. |
hidden | boolean | true if host is displayed in the Ops Manager UI. Hosts set to
true are omitted from API responses. |
hiddenSecondary | boolean | true if this host is a
hidden secondary. |
hostEnabled | boolean | true if the MongoDB process currently enabled. |
hostname | string | Primary hostname as Ops Manager can best determine. This can be a
hostname, an FQDN, an IPv4 address, or an IPv6 address. |
id | string | Unique identifier. |
ipAddress | string | IPv4 or IPv6 address associated with the hostname of
this MongoDB process. Additional accessible IPv4 or IPv6
addresses may be displayed in the aliases array. |
journalingEnabled | boolean | true if journaling is enabled for this MongoDB process. |
lastDataSizeBytes | number | Uncompressed size of the host's databases on disk in
bytes excluding indexes. lastDataSizeBytes does not
include the data in the
local database. |
lastIndexSizeBytes | number | Uncompressed size of the host's database indexes on disk
in bytes. This number does not include the size of the
index for the local
database. |
lastPing | date | Timestamp in ISO 8601 date and time format in UTC when the last ping for this MongoDB process
was received. |
lastRestart | date | Timestamp in ISO 8601 date and time format in UTC when this process last restarted. If the
MongoDB process has never been restarted, the lastRestart
field is omitted. |
links | array | Array that includes one or more links to sub-resources and/or
related resources. The relations between URLs are explained
in the Web Linking Specification. At minimum, a
links array contains one link called self . |
logsEnabled | boolean | true if Ops Manager is collecting logs for this MongoDB
process. |
lowUlimit | boolean | true if this MongoDB process's host has a low ulimit
setting. |
port | number | Port on which the MongoDB process listens. |
profilerEnabled | boolean | true if Ops Manager collects profile information from this
MongoDB process. |
replicaSetName | string | Name of the replica set this process belongs to. Only present
if this process is part of a replica set. |
replicaStateName | string | Current state of this MongoDB process within a replica set.
Only present if this process is part of a replica set. See
Replica Set Member States
for possible values. |
shardName | string | Name of the shard to which this process belongs. Only present
if the process is part of a sharded cluster. |
secondaryDelaySecs | number | Number of seconds this replica set member's data
trails the primary. If this value is set to 0 ,
the member is not configured as a delayed member.
For additional details on secondary delays, see
Delayed Replica Set Members |
sslEnabled | boolean | true if TLS/SSL and is enabled for this MongoDB
process. |
systemInfo | object | Object that contains RAM and CPU information for this MongoDB
process' server as reported by the operating system or
container. |
systemInfo.memSizeMB | number | Amount of RAM in megabytes. |
systemInfo.numCores | number | Number of CPU cores. |
typeName | string | Type for this MongoDB process. Possible values are:
The type for new hosts added to Ops Manager will be |
uptimeMsec | number | Number of milliseconds since this process last restarted. |
version | string | Version of MongoDB running for this process. |
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}?pretty=true"
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 "alertsEnabled" : true, 3 "aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ], 4 "authMechanismName" : "MONGODB_CR", 5 "clusterId" : "{CLUSTER-ID}", 6 "created" : "2014-04-22T19:56:50Z", 7 "groupId" : "{PROJECT-ID}", 8 "hasStartupWarnings" : false, 9 "hidden" : false, 10 "hostEnabled" : true, 11 "hostname" : "server1.example.com", 12 "id" : "{HOST-ID}", 13 "ipAddress": "10.1.0.10", 14 "journalingEnabled" : false, 15 "lastDataSizeBytes" : 633208918, 16 "lastIndexSizeBytes" : 101420524, 17 "lastPing" : "2016-08-18T11:23:41Z", 18 "links" : [ ], 19 "logsEnabled" : false, 20 "lowUlimit" : false, 21 "port" : 27017, 22 "profilerEnabled" : false, 23 "replicaSetName": "rs1", 24 "replicaStateName" : "PRIMARY", 25 "sslEnabled" : true, 26 "systemInfo" : { 27 "memSizeMB" : 65536, 28 "numCores" : 16 29 }, 30 "typeName": "REPLICA_PRIMARY", 31 "uptimeMsec": 1827300394, 32 "username" : "mongodb", 33 "version" : "4.0.0" 34 }