Get a limit set on a tenant

Hybrid Data Pipeline API reference : Administrators API : Limits API : Get a limit set on a tenant

Try Now

Purpose

Retrieves the value for a limit that has been set on a tenant.

URL

https://<myserver>:<port>/api/admin/limits/tenants/{tenantId}/{limitId}

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The following parameters are also required.

Parameter	Description	Valid Values
{tenantId}	The ID of the tenant.	The ID is auto-generated when the tenant is created and cannot be changed.
{limitId}	The ID of the limit.	MaxRowFetchSize (1) and ODataMaxConcurrentQueries (6) are the only limits that can be set on a tenant.

Response Definition

The response takes the following format.

{
"value": limit_value
}

Property	Description	Valid Values
"value"	The value of the limit.	An integer that meets the requirements of the minimum and maximum values for the limit.

Sample Server Success Response

Status code: 200
Successful response

{
"value": 400
}

Sample Server Failure Response

{
"error": {
"code": 222207916,
"message": {
"lang": "en-US",
"value": "There is no User with that id: 123."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the Limits (27) permission.