1 つのプロジェクトの 1 つのクラスターを取得
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
1 つのプロジェクト内の 1 つのクラスターの詳細を取得します。
必須のロール
割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
PROJECT-ID | string | プロジェクトの一意の識別子です。 |
CLUSTER-ID | string | 検索対象のクラスターの一意な識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答パラメータ
名前 | タイプ | 説明 |
|---|---|---|
clusterName | string | クラスターの表示名。 mongod自体ではクラスターに名前を付けることはできないことに注意してください。 Cloud Manager はこの名前を提供し、更新することができます。 シャーディングされたクラスター内のレプリカセットの場合、クラスター名はその親クラスターの名前になります。 |
groupId | string | クラスターが属するプロジェクトの一意の識別子。 |
id | string | クラスターの一意の識別子です。 |
lastHeartbeat | date | ISO8601 のタイムスタンプ Cloud Manager がこのクラスターからの ping を最後に処理した UTC 形式の日付と時刻形式。 |
replicaSetName | string | レプリカセット名。 Cloud Manager は、クラスターの typeNameがREPLICA_SETまたはCONFIG_SERVER_REPLICA_SETの場合、この値を返します。 |
shardName | string | シャード名。 Cloud Manager は、クラスターに typeName のSHARDED またはシャーディングされたクラスターの一部である がある場合、この値を返します。REPLICA_SET |
typeName | string |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true"
応答例
応答ヘッダー
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}
レスポンス本体
1 { 2 "clusterName": "myRS", 3 "groupId": "5e84b94c003f2d6370004f4e", 4 "id": "5e8ba20e87d9396ca9b96bd0", 5 "lastHeartbeat": "2020-06-10T14:51:28Z", 6 "links": [ 7 { 8 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", 9 "rel": "self" 10 } 11 ], 12 "replicaSetName": "myRS", 13 "typeName": "REPLICA_SET" 14 }