1 つのプロジェクト内の 1 つのクラスターの詳細を取得します。
必須のロール
割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | プロジェクトの一意の識別子です。 |
| string | 検索対象のクラスターの一意な識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答パラメータ
名前 | タイプ | 説明 |
|---|---|---|
| string | クラスターの表示名。 |
| string | クラスターが属するプロジェクトの一意の識別子。 |
| string | クラスターの一意の識別子です。 |
| date | MongoDB Ops Managerがこのクラスターからのpingを最後に処理したときの、ISO 8601の日付と時刻形式（UTC）のタイムスタンプ。 |
| string | レプリカセット名。 MongoDB Ops Manager は、クラスターに |
| string | シャード名。 MongoDB Ops Manager は、クラスターに |
| string | クラスターの種類。 MongoDB Ops Manager は次を返す場合があります。
|
リクエストの例
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"応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "clusterName": "myRS", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e8ba20e87d9396ca9b96bd0", "lastHeartbeat": "2020-06-10T14:51:28Z", "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", "rel": "self" } ], "replicaSetName": "myRS", "typeName": "REPLICA_SET"}