1 つの組織のすべてのプロジェクトを返す
指定した組織内の複数のプロジェクトを返します。各組織は複数のプロジェクトを持つことができます。プロジェクトを使用して、次の操作を行います。
- 開発環境、テスト環境、本番環境などの異なる環境を相互に分離します。
- 異なる MongoDB Cloud ユーザーまたはチームを異なる環境に関連付けるか、異なる環境の MongoDB Cloud ユーザーに異なる権限を付与します。
- 個別のクラスターセキュリティ構成を維持します。
- さまざまなアラート設定を作成します。
このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに組織メンバーのロールが必要です。
path パラメータ
-
プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。
デフォルト値は
true
です。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1
、最大値は500
です。デフォルト値は100
です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1
です。デフォルト値は1
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint -
返却するリストをフィルタリングするために使用される、人間が判読可能なプロジェクトのラベル。指定された名前のプレフィックスが付いた組織内のプロジェクトを、大文字と小文字を区別せずに検索します。
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/groups' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"clusterCount": 42,
"created": "2025-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [
{
"key": "string",
"value": "string"
}
],
"withDefaultAlertsSettings": true
}
],
"totalCount": 42
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"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": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}