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

ID を使用して 1 つのプロジェクトを取得

注意

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

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

GET /groups/{PROJECT-ID}
名前
タイプ
説明

プロジェクトID

string

(必須。) プロジェクトの一意の識別子。

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

名前
タイプ
説明

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/{PROJECT-ID}?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}
{ "id": "{PROJECT-ID}", "name": "My Project", "orgId" : "{ORG-ID}", "hostCounts": { "arbiter": 2, "config": 1, "primary": 4, "secondary": 8, "mongos": 2 }, "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), "activeAgentCount": 1, "replicaSetCount": 3, "shardCount": 2, "publicApiEnabled": true, "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e", "links" : []}