プロジェクトを 1 つ作成
プロジェクトを 1 つ作成します。プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラートを設定できます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに読み取り書き込みロールが必要です。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint -
指定したプロジェクト上で、プロジェクト所有者ロールを付与するMongoDB Cloud ユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。このパラメータを設定すると、最も古い組織オーナーのデフォルト値が上書きされます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
body
必須
プロジェクトを 1 つ作成します。
-
MongoDB Cloud の組織に含まれるプロジェクトを識別する、人間が判読可能なラベル。
形式は次のパターンと一致する必要があります:
^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
。 -
プロジェクトが属する MongoDB クラウド組織を識別する、ユニークな 24 桁の 16 進数文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。 -
政府の Atlas にのみ適用されます。
商用 Atlas では、このフィールドはリクエストで拒否され、応答が欠落します。
このフィールドは、プロジェクトで利用可能なリージョンの制限を設定します。
COMMERCIAL_FEDRAMP_REGIONS_ONLY
:FedRAMP Moderate リージョンでの配置のみを許可します。GOV_REGIONS_ONLY
:GovCloud リージョンでの配置のみを許可します。値は
COMMERCIAL_FEDRAMP_REGIONS_ONLY
またはGOV_REGIONS_ONLY
です。デフォルト値はCOMMERCIAL_FEDRAMP_REGIONS_ONLY
です。外部ドキュメント -
デフォルトのアラート設定でプロジェクトを作成するかどうかを示すフラグ。この設定は、プロジェクト作成後に更新することはできません。
デフォルト値は
true
です。
atlas api projects createGroup --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupApiParams{}
sdkResp, httpResp, err := client.ProjectsApi.
CreateGroupWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \
-d '{ <Payload> }'
{
"name": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": [
{
"key": "string",
"value": "string"
}
],
"withDefaultAlertsSettings": true
}
{
"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
}
{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}