Purpose

Retrieves limits that have been set on tenants.

URL

https://<myserver>:<port>/api/admin/limits/tenants

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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.

Response Definition

The response takes the following format.

{
  "tenantLimits": [
    {
      "tenantId": tenant_id,
      "tenantName": "tenant_name",
      "limits": [
        {
          "id": limit_id,
          "value": limit_value
        },
        ...
      ]
    },
    ...
  ]
}
Properties Description Valid Values
"tenantId" The ID of the tenant. The ID is auto-generated when the tenant is created and cannot be changed.
"tenantName" The name of the tenant. The maximum length is 128 characters.
"limits" A list of limits that have been set on the tenant. Includes the "id" and "value" properties where the "id" is the ID of the limit, and "value" is the value of the limit. MaxRowFetchSize (1) and ODataMaxConcurrentQueries (6) are the only limits that can be set on a tenant.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
  "tenantLimits": [
    {
      "tenantId": 1,
      "tenantName": "System",
      "limits": [ ]
    },
    {
      "tenantId": 71,
      "tenantName": "OrgA",
      "limits": [
        {
          "id": 1,
          "value": 1000
        },
        {
          "id": 6,
          "value": 100
        }
      ]
    }
  ]
}

Sample Server Failure Response 

{
  "error": {
    "code": 222207925,
    "message": {
      "lang": "en-US",
      "value": "Problem processing the limits at this time. Please try again at
                another time."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the Limits (27) permission. In addition, limits are only returned for tenants that the user has access to administer. Any user with the Administrator permission will see limits set on all tenants, while a user with the Limits permission needs administrative access on a given tenant to see that tenant's limits.