AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

現在のユーザーのすべてのプロジェクトを取得

注意

グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups

Request Parameters

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

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

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

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

名前
タイプ
必要性
説明
default

pageNum

数値

任意

結果のサブセクションを返す 1 から始まる整数。

1

itemsPerPage

数値

任意

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud 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 つのプロジェクトです。

名前
タイプ
説明

ActiveAgentCount

integer

Cloud Manager に定期的に ping を送信するアクティブなエージェントの数。

値は約24時間ごとに更新され、キャッシュされます。 新しいエージェントを開始するか、既存のエージェントを停止した場合、変更がactiveAgentCountフィールドに表示されるまでに最大30分かかることがあります。

hostCounts

オブジェクト

タイプ別のホストの合計数。 埋め込みフィールドは自己説明型である必要があります。

id

string

グループの一意の識別子です。

lastActiveAgent

string

Cloud Manager がプロジェクトのactiveAgentCountの合計を最後に更新した時間。 Cloud Manager はこの値を24時間ごとに更新し、アクティブな MongoDB エージェントの数を記録するためにキャッシュします。

Links

オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての links 配列には、self と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

name

string

プロジェクトの表示名。

orgId

string

プロジェクトが属する組織のユニーク識別子。

publicApiEnabled

ブール値

このプロジェクトで API が有効になっていることを示すフラグ。これは常にtrueである読み取り専用フィールドです。

replicaSetCount

integer

このプロジェクトのレプリカセットの合計数。

shardCount

integer

このプロジェクトのシャードの合計数。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups?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-alive
HTTP/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}

レスポンス本体

{  "links": [{    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",    "rel": "self"  }, {    "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",    "rel": "next"  }],  "results": [{    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56a10a80e4b0fd3b9a9bb0c2",    "lastActiveAgent": "2016-03-09T18:19:37Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "012i3091203jioawjioej",    "orgId": "5980cfdf0b6d97029d82f86e",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa691ce4b0a0e8c4be51f7",    "lastActiveAgent": "2016-01-29T19:02:56Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454008603036",    "orgId": "5980d0040b6d97029d831798",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa6dfde4b0fe328eee82ad",    "lastActiveAgent": "2016-01-29T20:34:28Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454009852809",    "orgId": "5980d0040b6d97029d831799",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa8421e4b0d04c1c54df99",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015520776",    "orgId": "5980d0040b6d97029d83179a",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }, {    "activeAgentCount": 0,    "hostCounts": {      "arbiter": 0,      "config": 0,      "mongos": 0,      "primary": 0,      "secondary": 0    },    "id": "56aa85f9e4b0d04c1c54e347",    "lastActiveAgent": "2016-01-29T21:36:10Z",    "links": [{      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",      "rel": "self"    }],    "name": "1454015992252",    "orgId": "5980d0040b6d97029d83179b",    "publicApiEnabled": true,    "replicaSetCount": 0,    "shardCount": 0,    "tags": []  }],  "totalCount": 5}
戻る
プロジェクト
次へ
IDで取得
このページを評価

項目一覧