DescribeLiveDomainTimeShiftData - ApsaraVideo Live

Usage notes

You can call this operation to query the resource usage data of time shifting at each time interval.
You can query data within the last 90 days.
The time interval between returned entries is 1 hour.
The maximum time range for a query is 31 days.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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 If you do not specify this parameter, the merged data of all your domain names is returned. You can specify multiple domain names. If you do so, separate them with commas (,).
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 The minimum time granularity is 5 minutes. If you do not specify this parameter, data in the previous 24 hours is queried.
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 granularity of the query. Unit: seconds. Valid values: 300 3600 86400 If you do not specify this parameter or specify an invalid value, the default value 300 is used.

Response parameters

Parameter	Type	Example	Description
RequestId	String	8AE1CB3A-6510-442E-A6B9-EF03D05B3E09	The request ID.
TimeShiftData	Array of DataModule		The resource usage data of time shifting that was collected for each time interval.
DataModule
Type	String	HLS_D7	The type of time shifting. Examples: HLS_D1 and HLS_D7.
TimeStamp	String	2021-03-03T00:00:00Z	The timestamp of the returned data.
Size	String	1664165660	The storage usage of time shifting. Unit: bytes.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainTimeShiftData
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainTimeShiftDataResponse>
<TimeShiftData>
    <DataModule>
        <Type>HLS_D7</Type>
        <Size>1664165660</Size>
        <TimeStamp>2021-03-03T00:00:00Z</TimeStamp>
    </DataModule>
</TimeShiftData>
<RequestId>8AE1CB3A-6510-442E-A6B9-EF03D05B3E09</RequestId>
</DescribeLiveDomainTimeShiftDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveDomainTimeShiftDataResponse" : {
    "TimeShiftData" : {
      "DataModule" : {
        "Type" : "HLS_D7",
        "Size" : 1664165660,
        "TimeStamp" : "2021-03-03T00:00:00Z"
      }
    },
    "RequestId" : "8AE1CB3A-6510-442E-A6B9-EF03D05B3E09"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The StartTime parameter is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The EndTime parameter is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

For a list of error codes, see Service error codes.

Operation-specific error codes

Error code	Error message	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The request was denied due to traffic throttling.
InvalidDomain.NotFound	The domain provided does not belong to you.	404	The specified domain name does not exist or does not belong to the current account.