Computing Credits
To ensure that there is optimal allocation and consumption of resources for a tenant, they are allocated a certain credits quota.
All operations performed for the tenant consume these credits, so the credits are also replenished or refilled at a specific rate. If your tenant resources consume the available credits faster than they are refilled, your credit balance may become zero or negative. If this happens, all operations may temporarily stop until the balance is replenished - batch operations, such as dataload and periodic tasks, slow down and the UI may display a service unavailable error. All operations resume once the credit balance is positive.
- Priority operations: These include low latency requests such as UI and integration scripts.
- Synchronous batch operations: These include higher latency requests such as data load or synchronous requests.
- Asynchronous batch operations: These include background or asynchronous requests and inconsistency resolution service activities like queries and tasks, or internal requests.
An alert is generated when the credits go below a specific threshold (25%). For information on your quota limit, see Quota and limits.
Viewing the Credit Balance
Use the following request to check the credit balance of your tenant. It shows the percentage of the maximum quota.
In the following example, 100% of your quota is available to you.
Request
GET {ApplicationURL}/api/{tenant_id}/monitoring/balanceResponse
{
"primary": {
"priorityCredits": 100,
"standardSyncCredits": 100,
"standardAsyncCredits": 100
},
"timestamp": 0,
"tenantId": "test_tenant"
}When you begin using your credits, the percentage for each operation will change accordingly. For example, when you have used 50% of your priority credits, your priority credits balance will decrease from 100% to 50%. The balance may increase or decrease further depending on the replenishment rate and usage.
Request
GET {ApplicationURL}/api/{tenant_id}/monitoring/balanceResponse
{
"primary": {
"priorityCredits": 50,
"standardSyncCredits": 100,
"standardAsyncCredits": 100
},
"timestamp": 0,
"tenantId": "test_tenant"
}