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

項目一覧

必須のロール

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

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

1 つのプロジェクト内のすべてのクラスターの詳細を取得します。

必須のロール

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

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/clusters

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

名前	タイプ	説明
`PROJECT-ID`	string	プロジェクトの一意の識別子です。

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

次のクエリパラメータは任意です。

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `results`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

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

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

応答

応答パラメータ

応答ドキュメント

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

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

`results` embeddedDocument

各結果は 1 つのクラスターです。

名前

タイプ

説明

clusterName

string

クラスターの表示名。 mongod自体ではクラスターに名前を付けることはできないことに注意してください。 MongoDB Ops Manager はこの名前を提供し、更新することができます。シャーディングされたクラスター内のレプリカセットの場合、クラスター名はその親クラスターの名前になります。

groupId

string

クラスターが属するプロジェクトの一意の識別子。

id

string

クラスターの一意の識別子です。

lastHeartbeat

date

ISO8601 のタイムスタンプMongoDB Ops Manager がこのクラスターからの ping を最後に処理した UTC 形式の日付と時刻。

replicaSetName

string

レプリカセット名。 MongoDB Ops Manager は、クラスターにtypeNameのREPLICA_SETまたはCONFIG_SERVER_REPLICA_SETがある場合、この値を返します。

shardName

string

シャード名。 MongoDB Ops Manager は、クラスターにtypeName SHARDEDのREPLICA_SET またはシャーディングされたクラスターの一部であるがある場合、この値を返します。

typeName

string

クラスターの種類。 MongoDB Ops Manager は次を返す場合があります。

`typeName`	説明
`REPLICA_SET`	レプリカセット。
`SHARDED`	各シャードがスタンドアロンインスタンスであるシャーディングされたクラスター。レプリカセットではないシャードはありません。
`SHARDED_REPLICA_SET`	レプリカセットであるシャードを少なくとも 1 つ含むシャーディングされたクラスター。
`CONFIG_SERVER_REPLICA_SET`	レプリカセットとして配置されたコンフィギュレーションサーバー。

リクエストの例

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?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://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",
5       "rel": "self"
6     }
7   ],
8   "results": [
9     {
10       "clusterName": "myRS",
11       "groupId": "5e84b94c003f2d6370004f4e",
12       "id": "5e8ba20e87d9396ca9b96bd0",
13       "lastHeartbeat": "2020-06-10T14:51:28Z",
14       "links": [
15         {
16           "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
17           "rel": "self"
18         }
19       ],
20       "replicaSetName": "myRS",
21       "typeName": "REPLICA_SET"
22     },
23     {
24       "clusterName": "cm-clstr-repl",
25       "groupId": "5e84b94c003f2d6370004f4e",
26       "id": "5e84e393395ec72bfc888f6c",
27       "lastHeartbeat": "2020-06-10T15:20:08Z",
28       "links": [
29         {
30           "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",
31           "rel": "self"
32         }
33       ],
34       "replicaSetName": "cm-clstr-repl",
35       "typeName": "REPLICA_SET"
36     }
37   ],
38   "totalCount": 2
39 }

戻る

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

1 つのプロジェクトの 1 つのクラスターを取得

1	{
2	"links": [
3	{
4	"href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",
5	"rel": "self"
6	}
7	],
8	"results": [
9	{
10	"clusterName": "myRS",
11	"groupId": "5e84b94c003f2d6370004f4e",
12	"id": "5e8ba20e87d9396ca9b96bd0",
13	"lastHeartbeat": "2020-06-10T14:51:28Z",
14	"links": [
15	{
16	"href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
17	"rel": "self"
18	}
19	],
20	"replicaSetName": "myRS",
21	"typeName": "REPLICA_SET"
22	},
23	{
24	"clusterName": "cm-clstr-repl",
25	"groupId": "5e84b94c003f2d6370004f4e",
26	"id": "5e84e393395ec72bfc888f6c",
27	"lastHeartbeat": "2020-06-10T15:20:08Z",
28	"links": [
29	{
30	"href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",
31	"rel": "self"
32	}
33	],
34	"replicaSetName": "cm-clstr-repl",
35	"typeName": "REPLICA_SET"
36	}
37	],
38	"totalCount": 2
39	}

必須のロール

リクエスト

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

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

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

応答

応答パラメータ

応答ドキュメント

results embeddedDocument

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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

`results` embeddedDocument