指定したプロジェクトの設定を更新します。使用可能なオプションはすべて更新できます。MongoDB クラウドは、リクエストで提供されたオプションのみを更新します。
- プロジェクトオーナー
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
更新する設定。
-
Atlas ホーム ページの MongoDB Assistant が指定されたプロジェクトで有効になっているかどうかを示すフラグ。
-
Flag that indicates whether the AI Cluster Assistant is enabled for the specified project.
-
指定されたプロジェクトのデータベース固有のメトリクスを収集するかどうかを示すフラグ。
-
指定されたプロジェクトに対して Data Explorer を有効にするかどうかを示すフラグ。
-
指定されたプロジェクトの Data Explorer で第 3 者サービスにリクエストを行う生成系AI 機能の使用を有効にするかどうかを示すフラグ。
-
指定されたプロジェクトの Data Explorer で、生成系AI 機能を使用してサンプル フィールドの値を渡すことを有効にするかどうかを示すフラグ。
デフォルト値は
falseです。 -
指定されたプロジェクト内のすべてのクラスターでデータ検証が有効になっているかどうかを示すフラグ。
-
指定されたプロジェクトに対してストレージ サイズ拡張を有効にするかどうかを示すフラグ。
-
指定されたプロジェクトの 集計パイプライン で、Voyage AIモデルを使用したネイティブの再ランク付けを有効にするかどうかを示すフラグ。
-
指定したプロジェクトの Performance Advisor とプロファイラーを有効にするかどうかを示すフラグ。
-
プロジェクトがプライベートエンドポイント接続文字列リソースを使用するかどうかを示すフラグ。
デフォルト値は
falseです。 -
指定したプロジェクトに対してリアルタイム パフォーマンス パネルを有効にするかどうかを示すフラグ。
-
指定されたプロジェクトに対してスキーマ アドバイザーを有効にするかどうかを示すフラグ。
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/settings' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"isAtlasHomePageAiAssistantEnabled": true,
"isClusterAiAssistantEnabled": true,
"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isDataExplorerGenAIFeaturesEnabled": true,
"isDataExplorerGenAISampleDocumentPassingEnabled": false,
"isDataValidationEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isNativeRerankingEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isPrivateEndpointConnectionStringsEnabled": false,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}'{
"isAtlasHomePageAiAssistantEnabled": true,
"isClusterAiAssistantEnabled": true,
"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isDataExplorerGenAIFeaturesEnabled": true,
"isDataExplorerGenAISampleDocumentPassingEnabled": false,
"isDataValidationEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isNativeRerankingEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isPrivateEndpointConnectionStringsEnabled": false,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}{
"isAtlasHomePageAiAssistantEnabled": true,
"isClusterAiAssistantEnabled": true,
"isCollectDatabaseSpecificsStatisticsEnabled": true,
"isDataExplorerEnabled": true,
"isDataExplorerGenAIFeaturesEnabled": true,
"isDataExplorerGenAISampleDocumentPassingEnabled": false,
"isDataValidationEnabled": true,
"isExtendedStorageSizesEnabled": true,
"isNativeRerankingEnabled": true,
"isPerformanceAdvisorEnabled": true,
"isPrivateEndpointConnectionStringsEnabled": false,
"isRealtimePerformancePanelEnabled": true,
"isSchemaAdvisorEnabled": true
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "Invalid Configuration. Contains selections that are unavailable due to your organization's resource policies.",
"error": 403,
"errorCode": "ATLAS_RESOURCE_POLICIES_VIOLATION_NOT_AUTHORIZED",
"parameters": [],
"policiesCausingDecision": [
{
"id": "32b6e34b3d91647abb20e7b8",
"name": "forbid-aws-clusters"
}
],
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"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",
"error": 409,
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK",
"reason": "Conflict"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}