Get Recording Quotas

Retrieves the recording storage quotas of a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/recording/quotas

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<Recording_Quota_Data> The recording storage quotas.
Recording_Quota_Data
Parameter Type Description
items Array<Retention_Quota_Item> The quota details of each retention duration tier.
totalAllocated Integer The total allocated quota, which is the sum of all tiers.
totalUsed Integer The used quota.
totalAvailable Integer The remaining available quota.
Retention_Quota_Item
Parameter Type Description
unit String

The unit of the retention duration:

  • day
  • month
  • year
unitValue Integer The value of the retention duration, for example 1, 3, or 6.
allocatedValue Integer The allocated quota of the tier.
used Integer The used quota of the tier.
available Integer The remaining available quota of the tier. The value -1 indicates no limit, and the value 0 indicates that the tier has expired.
expired Boolean

Whether the tier has expired:

  • true: The tier has expired.
  • false: The tier has not expired.
expireTime String The expiration time of the tier, in Unix milliseconds. The value 0 indicates that the tier never expires.

Example

Request example

GET /uc-cconfig/api/v1/recording/quotas HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTk4MTkwMiwiaWF0IjoxNzkxOTYwMzAyLCJqdGkiOiI5MTExMTA3YS1jODkzLTRmYjYtODJmNS0zYTFlNTUxMTVmODMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.zMBy3Vp-AkUDnJPCXFe5fO5C3UlhaH0PtkdozQs_-EBOIVzCYRW-Y5qRiRib0_N4p7ThH-IfuNJ65cmKyKcmOyPY5vvTzLkrN-WKZIBbTMSQWahDbSZx-VAvE7fDDh8U73V0WzCXdLuQTKEXdXcNO1XZE-ZFSUaS0bGGKh3zmrRNYI_qvywRs4Yn_SIeCWxDqZ7QmZiKgNBy_8NPGb1fUBJ-eFAjAzZX-JJ9oppT-xUKP00UPqoH30ZVvFnu9veW0m6pTzQXP881Xb9ja-7Z38oTOOug3mwUkFCgPFxU3rd4d9zNnjLsmT6MQdvDxeOpfqWPez-_tejmqMTyPpm05Q
x-tenant-code: colortest5

Response example

HTTP/1.1 200 OK
{
  "requestId": "d917b37436d57a2b332b5649c4050df4",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "items": [
      {
        "unit": "year",
        "unitValue": 1,
        "allocatedValue": 1,
        "used": 0,
        "available": 1,
        "expired": false,
        "expireTime": "1841119906000"
      },
      {
        "unit": "month",
        "unitValue": 1,
        "allocatedValue": 1,
        "used": 0,
        "available": 1,
        "expired": false,
        "expireTime": "1841119906000"
      }
    ],
    "totalAllocated": 2,
    "totalUsed": 0,
    "totalAvailable": 2
  }
}