Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Deployments
/
Clusters

Get One Cluster in One Project

On this page

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

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
PROJECT-ID
string
Unique identifier for the project.
CLUSTER-ID
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.
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:

Name
Description
status
HTTP response code
content
Expected response body
false

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Parameters

Name
Type
Description
clusterName
string
Display name of the cluster. Note that mongod itself doesn't allow you to name a cluster; Ops Manager supplies this name and you can update it. For a replica set within a sharded cluster, the cluster name is the name of its parent cluster.
groupId
string
Unique identifier of the project to which the cluster belongs.
id
string
Unique identifier of the cluster.
lastHeartbeat
date
Timestamp in ISO 8601 date and time format in UTC when Ops Manager most recently processed a ping from this cluster.
replicaSetName
string
Replica set name. Ops Manager returns this value when a cluster has a typeName of REPLICA_SET or CONFIG_SERVER_REPLICA_SET.
shardName
string
Shard name. Ops Manager returns this value when a cluster has a typeName of SHARDED or a REPLICA_SET that part of a sharded cluster.
typeName
string

Cluster type. Ops Manager may return:

typeName
Description
REPLICA_SET
SHARDED
A sharded cluster where each shard is a standalone instance. No shards are replica sets.
SHARDED_REPLICA_SET
A sharded cluster that contains at least one shard that is a replica set.
CONFIG_SERVER_REPLICA_SET
Config servers deployed as a replica set.

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

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  "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}

Back

Get All Clusters in One Project

Next

Update One Cluster