Queries the number of live recording channels and container format conversions.
Usage note
- You can call this operation to query the number of concurrent recording channels each day and event tracking data at different time intervals. These can be used to measure the peak number of concurrent recording channels on each day or month.
- The number of time-shifted channels is not included in the number of recording channels.
- You can query data by domain name or query data for multiple domain names. If you want to query data for multiple domain names, separate the domain names with commas (,).
- You can query data generated over the past 90 days.
- The data interval represents the time granularity of the data query. The data interval is fixed to one hour. You cannot customize data intervals.
- The maximum time range in which the data can be queried is 31 days.
QPS limit
A single user can perform a maximum of 10 queries per minute. Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLiveDomainRecordUsageData |
The operation that you want to perform. Set the value to DescribeLiveDomainRecordUsageData. |
StartTime | String | Yes | 2021-05-10T20:00:00Z |
The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
Note The earliest start time can be set to within 90 days from the current time, accurate
to seconds.
|
EndTime | String | Yes | 2021-05-10T21:00:00Z |
The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must meet the following requirements:
|
RegionId | String | No | cn-shanghai |
The region ID of the domain name. |
DomainName | String | No | example.com |
The main streaming domain to be queried.
|
SplitBy | String | No | domain,record_fmt |
The key that is used to group data. Valid values:
You can select only one option or both. If you want to select both options, separate them with a comma (,). The default value is |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RecordUsageData | Array of DataModule |
The recording data that was collected for each interval. |
|
DataModule | |||
Count | Long | 1 |
The peak channels. |
Domain | String | example.com |
The main streaming domain. This parameter is returned when values of the request parameter SplitBy contain |
Duration | Long | 3560 |
The recording duration in minutes. |
TimeStamp | String | 2021-05-10T20:00:00Z |
The time to start recording. |
Type | String | MP4 |
The recording file type. This parameter is returned when values of the request parameter SplitBy contain |
RequestId | String | 4B460F8B-993C-4F48-B98A-910811DEBFEB |
The ID of the request. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainRecordUsageData
&DomainName=example.com
&StartTime=2021-05-10T20:00:00Z
&EndTime=2021-05-10T21:00:00Z
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveDomainRecordUsageDataResponse>
<RequestId>4B460F8B-993C-4F48-B98A-910811DEBFEB</RequestId>
<RecordUsageData>
<DataModule>
<Type>MP4</Type>
<Duration>3560</Duration>
<Count>1</Count>
<Domain>example.com</Domain>
<TimeStamp>2021-05-10T20:00:00Z</TimeStamp>
</DataModule>
<DataModule>
<Type>TS</Type>
<Duration>3476</Duration>
<Count>1</Count>
<Domain>example.com</Domain>
<TimeStamp>2021-05-10T20:00:00Z</TimeStamp>
</DataModule>
</RecordUsageData>
</DescribeLiveDomainRecordUsageDataResponse>
JSON
format
{
"RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
"RecordUsageData": {
"DataModule": [
{
"Type": "MP4",
"Duration": 3560,
"Count": 1,
"Domain": "example.com",
"TimeStamp": "2021-05-10T20:00:00Z"
},
{
"Type": "TS",
"Duration": 3476,
"Count": 1,
"Domain": "example.com",
"TimeStamp": "2021-05-10T20:00:00Z"
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is valid. |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is valid. |
400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | The error message returned because the end time is not later than the start time or the time range specified by the StartTime and EndTime parameters is beyond 31 days. Check whether the values of the StartTime and EndTime parameters are valid. |
For a list of error codes, visit the API Error Center.
Special error codes
Error code |
Error message |
HTTP status code |
Description |
---|---|---|---|
Throttling |
Request was denied due to request throttling. |
503 |
The error message returned because the request was denied due to throttling. |
InvalidDomain.NotFound |
The domain provided does not belong to you. |
404 |
The error message returned because the domain name does not exist or does not belong to your Alibaba Cloud account. |