プロジェクト設定の更新
指定したプロジェクトの設定を更新します。使用可能なオプションはすべて更新できます。MongoDB クラウドは、リクエストで提供されたオプションのみを更新します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
更新する設定。
-
指定されたプロジェクトのデータベース固有のメトリクスを収集するかどうかを示すフラグ。
-
指定されたプロジェクトに対して Data Explorer を有効にするかどうかを示すフラグ。
-
指定されたプロジェクトの Data Explorer で第 3 者サービスにリクエストを行う生成系AI 機能の使用を有効にするかどうかを示すフラグ。
-
指定されたプロジェクトの Data Explorer で、生成系AI 機能を使用してサンプル フィールドの値を渡すことを有効にするかどうかを示すフラグ。
デフォルト値は
falseです。 -
指定されたプロジェクトに対してストレージ サイズ拡張を有効にするかどうかを示すフラグ。
-
指定したプロジェクトの Performance Advisor とプロファイラーを有効にするかどうかを示すフラグ。
-
指定したプロジェクトに対してリアルタイム パフォーマンス パネルを有効にするかどうかを示すフラグ。
-
指定されたプロジェクトに対してスキーマ アドバイザーを有効にするかどうかを示すフラグ。
atlas api projects updateGroupSettings --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/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.UpdateGroupSettingsApiParams{}
sdkResp, httpResp, err := client.ProjectsApi.
UpdateGroupSettingsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
-d '{ <Payload> }'{
"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isDataExplorerGenAIFeaturesEnabled": true,
"isDataExplorerGenAISampleDocumentPassingEnabled": false,
"isExtendedStorageSizesEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}{
"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isDataExplorerGenAIFeaturesEnabled": true,
"isDataExplorerGenAISampleDocumentPassingEnabled": false,
"isExtendedStorageSizesEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}{
"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"
}