GET
URI:
-
/api/v1/quota
Input fields:
| Field name | Type | Required | Description |
|---|---|---|---|
| realm_id | string | No | The realm ID. |
| brief | boolean | No | Whether to get user quota details per realm. |
Successful response fields:
| Field name | Type | Description |
|---|---|---|
| usage | integer | The user count. |
| total_quota | integer | The total user quota. |
| trial_status | integer |
Customer trial status, which can be one of the following:
|
| end_date | string | The latest license expiration date. |
| realms | list The realm quota allocation details, for each item [realm_id, quota, usage] | The realm quota allocation details, for each item (e.g., realm_id, quota, usage, etc.) |
Response codes:
| Code | Response content | Description |
|---|---|---|
| 200 OK | User quota info has been successfully returned. | |
| 404 Not Found |
|
Example request body:
None
Example of successful response body:
{
"usage":10,
"total_quota":240,
"trial_status":2,
"end_date":"2030-11-18",
"realms":[
[
"12345678-abcd-efgh-1234-xxxxxxxxxxxx",
10,
1
]
]
}