アクセス可能なすべてのプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。このレスポンスには、マルチクラウド クラスターは含まれません。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにクラスターレベルの任意のロールを持たせることができます。
アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。
デフォルト値はfalseです。
レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。
デフォルト値はtrueです。
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は 1、最大値は 500 です。デフォルト値は 100 です。
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は 1 です。デフォルト値は 1 です。
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値はfalseです。
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/clusters' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"clusters": [
{
"alertCount": 42,
"authEnabled": true,
"availability": "available",
"backupEnabled": true,
"clusterId": "string",
"dataSizeBytes": 42,
"name": "string",
"nodeCount": 42,
"sslEnabled": true,
"type": "REPLICA_SET",
"versions": [
"string"
]
}
],
"groupId": "string",
"groupName": "string",
"orgId": "string",
"orgName": "string",
"planType": "string",
"tags": [
"string"
]
}
],
"totalCount": 42
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}