OData query throttling for users
- Last Updated: May 18, 2023
- 3 minute read
- Hybrid Data Pipeline
- Version 5.0
- Documentation
Hybrid Data Pipeline supports throttling the number of simultaneous OData requests a user may have running against a Hybrid Data Pipeline server at a time. OData query throttling for users may be configured with the ODataMaxConcurrentRequests and ODataMaxWaitingRequests limits. The ODataMaxConcurrentRequests limit sets the maximum number of simultaneous OData requests allowed per user, while the ODataMaxWaitingRequests limit sets the maximum number of waiting OData requests allowed per user. These limits can be applied at three levels in the following manner.
- User. When applied to a user, the limits apply only to that user. Limits set at the user level override limits set at the tenant and system level.
- Tenant. When applied to a tenant, the limits apply to all users in the tenant. Limits set at the tenant level override limits set at the system level.
- System. When applied at the system level, the limits apply to all users in the Hybrid Data Pipeline system.
To configure OData query throttling on users, the administrator must have either the Administrator (12) or the Limits (27) permission.
System level configuration
OData query throttling on users can be configured at the system level either with the Web UI or with the Limits API. For details on using the Web UI, see Manage Limits view.
The following POST sets a limit of 100 queries allowed per user across the system. The number 24 is the ID of the ODataMaxConcurrentRequests limit. The payload passes 100 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/system/24
{
"value": 100
}
The following POST sets a limit of 50 waiting queries allowed per user across the system. The number 25 is the ID of the ODataMaxWaitingRequests limit. The payload passes 50 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/system/25
{
"value": 50
}
Tenant configuration
OData query throttling on users can be configured at the tenant level with either the Web UI or with the Limits API. When using the Web UI, you can enable OData query throttling on users through either the Manage Tenants view or the Manage Limits view.
The following POST sets a limit of 100 queries allowed per user across the tenant. The number 32 is the ID of the tenant, and the number 24 is the ID of the ODataMaxConcurrentRequests limit. The payload passes 100 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/tenants/32/24
{
"value": 100
}
The following POST sets a limit of 50 waiting queries allowed per user across the tenant. The number 32 is the ID of the tenant, and the number 25 is the ID of the ODataMaxWaitingRequests limit. The payload passes 50 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/tenants/32/25
{
"value": 50
}
User account configuration
OData query throttling on users can be configured at the user level either with the Web UI or with the Limits API. For details on using the Web UI, see Manage Users view.
The following POST sets a limit of 100 queries allowed per user across the tenant. The number 86 is the ID of the user account, and the number 24 is the ID of the ODataMaxConcurrentRequests limit. The payload passes 100 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/users/86/24
{
"value": 100
}
The following POST sets a limit of 50 queries allowed per user across the tenant. The number 86 is the ID of the user account, and the number 25 is the ID of the ODataMaxWaitingRequests limit. The payload passes 50 as the value for this limit.
POST https://<myserver>:<port>/api/admin/limits/users/86/25
{
"value": 100
}