1 つのフェデレーティッドデータベースインスタンスの 1 つのクエリ制限を構成
1 つのフェデレーティッドデータベースインスタンスに対して 1 つのクエリ制限を作成または更新します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。 -
クエリ制限が適用されるフェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。
-
このデータ フェデレーション インスタンスの制限を識別する、人間が判読可能なラベル。
制限名 説明 default bytesProcessed.query 単一のデータフェデレーション クエリ中に処理されるバイト数の制限 該当なし bytesProcessed.daily データフェデレーション インスタンスの現在日に処理されるバイト数の制限 該当なし bytesProcessed.weekly データフェデレーション インスタンスの現在の週に処理されるバイト数の制限 該当なし bytesProcessed.monthly データフェデレーション インスタンスの現在の月に処理されるバイト数の制限 該当なし 値は、
bytesProcessed.query
、bytesProcessed.daily
、bytesProcessed.weekly
、またはbytesProcessed.monthly
です。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。
atlas api dataFederation setGroupDataFederationLimit --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.SetGroupDataFederationLimitApiParams{}
sdkResp, httpResp, err := client.DataFederationApi.
SetGroupDataFederationLimitWithParams(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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \
-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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \
-d '{ <Payload> }'
{
"overrunPolicy": "BLOCK",
"value": 42
}
{
"currentUsage": 42,
"defaultLimit": 42,
"lastModifiedDate": "2025-05-04T09:42:00Z",
"maximumLimit": 42,
"name": "string",
"overrunPolicy": "BLOCK",
"tenantName": "string",
"value": 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"
}