Query Tenant Resource Usage and Capacity

Query the usage and capacity limits of key system resources for a specified tenant.

Request URL

GET {base_url}/uc-dashboard/api/v1/dashboard/tenant/usage

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Tenant_Usage> The information of resource usage and limit within the specified tenant.
Tenant_Usage
Parameter Type Description
items Array<Resource_Usage> The usage and capacity limits of key system resources, including IVR, queue, ring group, and DID.
recording Array<Recording_Usage> The usage and limits of recording capacity.
twoFactorEnabled Boolean Whether two-factor authentication is enforced for all tenant users.
  • true
  • false
snapshotTime Integer The timestamp of the latest usage update (unit: milliseconds).
Resource_Usage
Parameter Type Description
resource String The resource type.
  • ivr
  • queue
  • ringGroup
  • did
used Integer The number of created resource.
total Integer The maximum supported number of the resource.
Recording_Usage
Parameter Type Description
packageValue Integer The value of the recording retention package.
packageUnit String The unit of the recording retention package.
  • day
  • month
  • year
used Integer The used recording capacity.
total Integer The maximum supported recording capacity.

Example

Request example

GET /uc-dashboard/api/v1/dashboard/tenant/usage HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODQzNDU2NywiaWF0IjoxNzg4NDEyOTY3LCJqdGkiOiJhYzYwMWJkOC02NDdkLTRlNzUtOGI2MS1mNmRiZmZhZDk1YzkiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.4RbFpLSVFGMpgp-xAFfNMU82J4I4WbxIskKD27vp4ge3pEhdUsr-qHnHh3Qm78xPx7cbXl8pp5UmNfQWH7pZ1u4Rx2WlR-WcfrdPJvCSxnru4UbBxU9BC9DBQyEVOKYmnTHqEosEZkoaHdlDySHdNCg1mxgcVwk3mczlognjSpAkuoMTNydq_gReUToc-v0SPS3YMDhJsCSC_NDuG4b9jc8B703hiM-FzVfOUdrluVfIsjT-skM7ZwOWH7p7uT_Y_uEi1QUuQUgB-bKc2Vb7PTajXRETtdvJS-yxca5Gv8Z5EGEzk4ThEuSh1xrxelYpMzvwyEjbW5Nak4joLiE_lQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "c5bf2c4dcad2957d72c4e0b57e6cd973",
  "code": "200",
  "message": "SUCCESS",
  "result": {
    "items": [
      {
        "resource": "ivr",
        "used": 1,
        "total": 35
      },
      {
        "resource": "ringGroup",
        "used": 0,
        "total": 25
      },
      {
        "resource": "queue",
        "used": 1,
        "total": 36
      }
    ],
    "recording": [
      {
        "packageValue": 1,
        "packageUnit": "year",
        "used": 0,
        "total": 1
      }
    ],
    "twoFactorEnabled": false,
    "snapshotTime": 1787815337163
  }
}