Configurar um limite de consulta para uma instância de banco de dados federada
Cria ou atualiza um limite de consulta para uma instância do banco de dados federado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Rótulo legível por humanos que identifica a instância do banco de dados federado à qual o limite de consulta se aplica.
-
Etiqueta legível para humanos que identifica este limite de instância de Data Federation.
Nome do limite Descrição Default bytesProcessed.query Limite do número de bytes processados durante uma única query de federação de dados N/A bytesProcessed.daily Limite do número de bytes processados para a instância de federação de dados para o dia atual N/A bytesProcessed.weekly Limite do número de bytes processados para a instância de federação de dados da semana vigente N/A bytesProcessed.monthly Limite do número de bytes processados para a instância de federação de dados do mês vigente N/A Os valores são
bytesProcessed.query,bytesProcessed.daily,bytesProcessed.weeklyoubytesProcessed.monthly.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false.
corpo, corpo
Obrigatório
Cria ou atualiza um limite de query para uma instância do banco de dados federado.
-
Usado apenas para limites do Data Federation. Ação a ser tomada quando o limite de uso for excedido. Se a extensão limite for definida como QUERY, isso será ignorado porque o MongoDB Cloud interromperá a query quando ela exceder o limite de uso.
Os valores são
BLOCKouBLOCK_AND_KILL. -
Valor da definição do limite.
atlas api dataFederation setGroupDataFederationLimit --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/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-11-15+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-11-15+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"
}