Data Federation

Configure One Query Limit for One Federated Database Instance

Creates or updates one query limit for one federated database instance.

patch/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}

Request

Base URL
https://cloud.mongodb.com
URL
https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}
Auth
- OAuth 2
  Client credentials
  Token URL: https://cloud.mongodb.com/api/oauth/token
- or HTTP digest

Path parameters

groupIdstring required

Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

tenantNamestring required

Human-readable label that identifies the federated database instance to which the query limit applies.

limitName'bytesProcessed.query' | 'bytesProcessed.daily' | 'bytesProcessed.weekly' | 'bytesProcessed.monthly' required

Human-readable label that identifies this data federation instance limit.

Limit Name	Description	Default
bytesProcessed.query	Limit on the number of bytes processed during a single data federation query	N/A
bytesProcessed.daily	Limit on the number of bytes processed for the data federation instance for the current day	N/A
bytesProcessed.weekly	Limit on the number of bytes processed for the data federation instance for the current week	N/A
bytesProcessed.monthly	Limit on the number of bytes processed for the data federation instance for the current month	N/A

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request body

currentUsageinteger

Amount that indicates the current usage of the limit.

defaultLimitinteger

Default value of the limit.

lastModifiedDatestring date-time

Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.

maximumLimitinteger

Maximum value of the limit.

namestring required

Human-readable label that identifies the user-managed limit to modify.

overrunPolicy'BLOCK' | 'BLOCK_AND_KILL'

Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.

tenantNamestring

Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.

valueinteger required

Amount to set the limit to.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.