为一个联合数据库实例配置一个查询限制
为一个联合数据库实例创建或更新一个查询限制。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目所有者”角色。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式:
^([a-f0-9]{24})$
。 -
用于标识应用查询限制的联合数据库实例的人类可读标签。
-
人类可读标签,用于标识此数据联合实例限制。
限制名称 说明 默认 bytesProcessed.query 单个 Data Federation 查询期间处理的字节数限制 不适用 bytesProcessed.daily 针对数据联合实例当周处理的字节数限制 不适用 bytesProcessed.weekly 针对数据联合实例的当周处理字节数限制 不适用 bytesProcessed.monthly 针对数据联合实例的当月处理字节数限制 不适用 取值为
bytesProcessed.query
、bytesProcessed.daily
、bytesProcessed.weekly
或bytesProcessed.monthly
。
查询参数
-
指示应用程序是否将响应包装在
envelope
JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false
。
PATCH /api/atlas/v2 /groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}
Atlas CLI
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
}
响应示例 (200)
{
"currentUsage": 42,
"defaultLimit": 42,
"lastModifiedDate": "2025-05-04T09:42:00Z",
"maximumLimit": 42,
"name": "string",
"overrunPolicy": "BLOCK",
"tenantName": "string",
"value": 42
}
响应示例 (400)
{
"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"
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"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"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}