すべてのプロジェクトのすべてのクラスターを取得する

項目一覧

必須のロール

リクエスト
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答パラメータ
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

リクエストを行っているプログラム API キーで利用可能なすべてのプロジェクト内のすべてのクラスターの詳細を取得します。

必須のロール

割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。

リクエスト

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

GET /api/public/v1.0/clusters

リクエストパスパラメーター

このエンドポイントは、HTTP リクエストパスパラメーターを使用しません。

リクエストクエリパラメータ

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print にするかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答パラメータ

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、`results` 埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのプロジェクトです。

名前	タイプ	説明
`clusters`	オブジェクトの配列	API キーが表示を許可されている各プロジェクト内のクラスターを記述するオブジェクト。
`clusters.[n].alertCount`	integer	オープンアラートの数。
`clusters.[n].authEnabled`	ブール値	クラスター内のノードにアクセスするために認証が必要かどうかを指定します。
`clusters.[n].availability`	string	クラスターの可用性。値には、次のものが含まれます。 `available`: クラスター内のすべてのノードが使用できます。 `warning`: クラスター内の一部のノードは使用できます。少なくとも 1 つのノードが使用できません。 `unavailable`: クラスターは使用できません。クラスターにはプライマリノードがありません。 `dead`: クラスターは非アクティブです。
`clusters.[n].backupEnabled`	ブール値	クラスターのバックアップを有効にするかどうかを指定します。
`clusters.[n].clusterId`	string	Cloud Manager クラスターの一意の識別子です。
`clusters.[n].dataSizeBytes`	数値	クラスター内の各ノードに保存されているデータの合計サイズ（バイト単位）。
`clusters.[n].name`	string	Cloud Manager に表示されるクラスターの名前。
`clusters.[n].nodeCount`	integer	クラスター内のノードの数。
`clusters.[n].sslEnabled`	ブール値	クラスター内のノードにアクセスするためにSSL認証が必要かどうかを指定します。
`clusters.[n].type`	string	MongoDB クラスターのタイプ。値には、次のものが含まれます。 `replica set`:レプリカセット `sharded cluster`:シャーディングされたクラスター `standalone`:スタンドアロン
`clusters.[n].versions`	文字列の配列	クラスター内の各ノードが実行している MongoDB のバージョン。
`groupId`	string	プロジェクトの一意の識別子。
`groupName`	string	返されたクラスターが属するプロジェクトの名前。
`orgId`	string	返されたクラスターが属するプロジェクトを所有する組織の一意の識別子。
`orgName`	string	返されたクラスターが属するプロジェクトを所有する組織の名前。
`planType`	string	プランタイプ。 Cloud Manager では、この値は常に Cloud Manager です。
`tags`	文字列の配列	プロジェクトに適用されたタグ。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/clusters?pretty=true"

応答例

応答ヘッダー

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}

レスポンス本体

1 {
2   "links" : [
3     {
4       "href" : "https://cloud.mongodb.com/api/public/v1.0/clusters",
5       "rel" : "self"
6     }
7   ],
8   "results" : [
9     {
10       "clusters" : [
11         {
12           "alertCount" : 0,
13           "authEnabled" : true,
14           "availability" : "available",
15           "backupEnabled" : false,
16           "clusterId" : "5e6bc0352e41683c191c8956",
17           "dataSizeBytes" : 0,
18           "name" : "Cluster1",
19           "nodeCount" : 3,
20           "sslEnabled" : true,
21           "type" : "replica set",
22           "versions" : [
23             "4.2.3"
24           ]
25         },
26         {
27           "alertCount" : 0,
28           "authEnabled" : true,
29           "availability" : "available",
30           "backupEnabled" : false,
31           "clusterId" : "5e6bc60ba4c3f47a54d8fe95",
32           "dataSizeBytes" : 0,
33           "name" : "Cluster2",
34           "nodeCount" : 3,
35           "sslEnabled" : true,
36           "type" : "replica set",
37           "versions" : [
38             "4.2.3"
39           ]
40         }
41       ],
42       "groupId" : "5df90932f10fab675508b0e5",
43       "groupName" : "az",
44       "orgId" : "5df7a168f10fab3a149357fb",
45       "orgName" : "jww-12-16",
46       "planType" : "Cloud Manager",
47       "tags" : [
48 
49       ]
50     },
51     {
52       "clusters" : [
53         {
54           "alertCount" : 0,
55           "authEnabled" : true,
56           "availability" : "available",
57           "backupEnabled" : false,
58           "clusterId" : "5e6bbf6a9de0d35b1527dd93",
59           "dataSizeBytes" : 0,
60           "name" : "Cluster0",
61           "nodeCount" : 3,
62           "sslEnabled" : true,
63           "type" : "replica set",
64           "versions" : [
65             "4.2.3"
66           ]
67         }
68       ],
69       "groupId" : "5df90590f10fab5e33de2305",
70       "groupName" : "jww-12-17",
71       "orgId" : "5df7a168f10fab3a149357fb",
72       "orgName" : "jww-12-16",
73       "planType" : "Cloud Manager",
74       "tags" : [
75 
76       ]
77     },
78     {
79       "clusters" : [
80         {
81           "alertCount" : 0,
82           "authEnabled" : true,
83           "availability" : "dead",
84           "backupEnabled" : false,
85           "clusterId" : "5e6be93fd434591c4ca765f6",
86           "dataSizeBytes" : 0,
87           "name" : "Cluster0",
88           "nodeCount" : 0,
89           "sslEnabled" : true,
90           "type" : "replica set",
91           "versions" : [
92             "4.2.3"
93           ]
94         }
95       ],
96       "groupId" : "5df90923f10fab675508b065",
97       "groupName" : "gcp",
98       "orgId" : "5df7a168f10fab3a149357fb",
99       "orgName" : "jww-12-16",
100       "planType" : "Cloud Manager",
101       "tags" : [
102 
103       ]
104     }
105   ],
106   "totalCount" : 3
107 }

戻る

クラスター

1 つのプロジェクトのすべてを取得

1	{
2	"links" : [
3	{
4	"href" : "https://cloud.mongodb.com/api/public/v1.0/clusters",
5	"rel" : "self"
6	}
7	],
8	"results" : [
9	{
10	"clusters" : [
11	{
12	"alertCount" : 0,
13	"authEnabled" : true,
14	"availability" : "available",
15	"backupEnabled" : false,
16	"clusterId" : "5e6bc0352e41683c191c8956",
17	"dataSizeBytes" : 0,
18	"name" : "Cluster1",
19	"nodeCount" : 3,
20	"sslEnabled" : true,
21	"type" : "replica set",
22	"versions" : [
23	"4.2.3"
24	]
25	},
26	{
27	"alertCount" : 0,
28	"authEnabled" : true,
29	"availability" : "available",
30	"backupEnabled" : false,
31	"clusterId" : "5e6bc60ba4c3f47a54d8fe95",
32	"dataSizeBytes" : 0,
33	"name" : "Cluster2",
34	"nodeCount" : 3,
35	"sslEnabled" : true,
36	"type" : "replica set",
37	"versions" : [
38	"4.2.3"
39	]
40	}
41	],
42	"groupId" : "5df90932f10fab675508b0e5",
43	"groupName" : "az",
44	"orgId" : "5df7a168f10fab3a149357fb",
45	"orgName" : "jww-12-16",
46	"planType" : "Cloud Manager",
47	"tags" : [
48
49	]
50	},
51	{
52	"clusters" : [
53	{
54	"alertCount" : 0,
55	"authEnabled" : true,
56	"availability" : "available",
57	"backupEnabled" : false,
58	"clusterId" : "5e6bbf6a9de0d35b1527dd93",
59	"dataSizeBytes" : 0,
60	"name" : "Cluster0",
61	"nodeCount" : 3,
62	"sslEnabled" : true,
63	"type" : "replica set",
64	"versions" : [
65	"4.2.3"
66	]
67	}
68	],
69	"groupId" : "5df90590f10fab5e33de2305",
70	"groupName" : "jww-12-17",
71	"orgId" : "5df7a168f10fab3a149357fb",
72	"orgName" : "jww-12-16",
73	"planType" : "Cloud Manager",
74	"tags" : [
75
76	]
77	},
78	{
79	"clusters" : [
80	{
81	"alertCount" : 0,
82	"authEnabled" : true,
83	"availability" : "dead",
84	"backupEnabled" : false,
85	"clusterId" : "5e6be93fd434591c4ca765f6",
86	"dataSizeBytes" : 0,
87	"name" : "Cluster0",
88	"nodeCount" : 0,
89	"sslEnabled" : true,
90	"type" : "replica set",
91	"versions" : [
92	"4.2.3"
93	]
94	}
95	],
96	"groupId" : "5df90923f10fab675508b065",
97	"groupName" : "gcp",
98	"orgId" : "5df7a168f10fab3a149357fb",
99	"orgName" : "jww-12-16",
100	"planType" : "Cloud Manager",
101	"tags" : [
102
103	]
104	}
105	],
106	"totalCount" : 3
107	}