Get One Cluster in One Project
Retrieve details for one cluster in one project.
Required Roles
You can successfully call this endpoint with any assigned role.
Request
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
Request Path Parameters
Name | Type | Description |
---|---|---|
| string | Unique identifier for the project. |
| string | Unique identifier for the cluster you want to retrieve. |
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. |
| ||||||
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:
|
|
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Response Parameters
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Display name of the cluster. Note that | ||||||||||
| string | Unique identifier of the project to which the cluster belongs. | ||||||||||
| string | Unique identifier of the cluster. | ||||||||||
| date | Timestamp in ISO 8601 date and time format in UTC when Ops Manager most recently processed a ping from this cluster. | ||||||||||
| string | Replica set name. Ops Manager returns this value when a cluster has a
| ||||||||||
| string | Shard name. Ops Manager returns this value when a cluster has a
| ||||||||||
| string | Cluster type. Ops Manager may return:
|
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-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 "clusterName": "myRS", 3 "groupId": "5e84b94c003f2d6370004f4e", 4 "id": "5e8ba20e87d9396ca9b96bd0", 5 "lastHeartbeat": "2020-06-10T14:51:28Z", 6 "links": [ 7 { 8 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", 9 "rel": "self" 10 } 11 ], 12 "replicaSetName": "myRS", 13 "typeName": "REPLICA_SET" 14 }