The v2.0 versions of the three Get Host endpoints return everything the v1.0 endpoints return. They add two fields that report a replica set member's replication health. Use these endpoints to detect a member that is too stale to catch up and to read its replication error.
Adding fields to an existing response can break clients that validate the schema strictly. The v1.0 endpoints are unchanged and never return these fields.
Prerequisites
Before you use the v2.0 Get Host resources, review the following requirements.
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.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0
To use the v2.0 Get Host resources, you must be an Ops Manager user with at least the Project Read Only role.
Your deployment must run Ops Manager 8.0.28 or 9.0.2 or later. Monitoring must be enabled for the project. If monitoring is disabled, Ops Manager omits the new fields.
Endpoints
The following table lists the endpoints available for the v2.0 Get Host resources. The paths match the v1.0 endpoints under the v2.0 base URL.
Method | Endpoint | Description |
|---|---|---|
| Returns one host by its unique identifier. | |
| Returns one host by its hostname and port. | |
| Returns all hosts in the project. |
New Response Fields
The v2.0 endpoints return the following fields in addition to the v1.0 response fields.
Name | Type | Description |
|---|---|---|
tooStale | boolean |
|
lastReplError | string | The member's last replication error, from the |
Both fields describe this host's own member entry in its replica set. Ops Manager omits them for hosts that aren't replica set members, and omits lastReplError when the member reports no error.