Queries the resource usage data of time shifting for one or more domain names.
Usage note
- You can specify multiple domain names and separate them with commas (,).
- You can query the data of the last 90 days at most.
- The time interval between returned entries is 1 hour.
- The maximum time range in which the data can be queried in a call 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 | DescribeLiveDomainTimeShiftData |
The operation that you want to perform. Set the value to DescribeLiveDomainTimeShiftData. |
DomainName | String | No | example.com |
The main streaming domain. Note
|
StartTime | String | No | 2021-03-03T00: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
|
EndTime | String | No | 2021-03-03T02: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 end time must be later than the start time. |
Interval | String | No | 300 |
The time interval at which the data is to be queried. Unit: seconds. Valid values:
If you do not set this parameter or the specified value is invalid, the default value 300 is used. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 8AE1CB3A-6510-442E-A6B9-EF03D05B3E09 |
The ID of the request. |
TimeShiftData | Array of DataModule |
The resource usage data of time shifting that was collected for each time interval. |
|
DataModule | |||
Size | String | 1664165660 |
The storage usage of time shifting. Unit: byte. |
TimeStamp | String | 2021-03-03T00:00:00Z |
The timestamp of the returned data. |
Type | String | HLS_D7 |
The type of time shifting. Examples: HLS_D1 and HLS_D7. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainTimeShiftData
&StartTime=2021-03-03T00:00:00Z
&EndTime=2021-03-03T02:00:00Z
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveDomainTimeShiftDataResponse>
<TimeShiftData>
<DataModule>
<Type>HLS_D7</Type>
<Size>1664165660</Size>
<TimeStamp>2021-03-03T00:00:00Z</TimeStamp>
</DataModule>
<DataModule>
<Type>HLS_D7</Type>
<Size>1308431308</Size>
<TimeStamp>2021-03-03T01:00:00Z</TimeStamp>
</DataModule>
</TimeShiftData>
<RequestId>E8942890-A783-4456-BEF8-81FDDD8F8F3C</RequestId>
</DescribeLiveDomainTimeShiftDataResponse>
JSON
format
{
"TimeShiftData": {
"DataModule": [
{
"Type": "HLS_D7",
"Size": 1664165660,
"TimeStamp": "2021-03-03T00:00:00Z"
},
{
"Type": "HLS_D7",
"Size": 1308431308,
"TimeStamp": "2021-03-03T01:00:00Z"
}
]
},
"RequestId": "E8942890-A783-4456-BEF8-81FDDD8F8F3C"
}
Error codes
HTTP status code | 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 earlier than the start time. 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 the current user. |