DescribeLiveDelayedStreamingUsage - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the stream delay usage data.

Usage notes

You can call this operation to query your stream delay usage data. The default time granularity is 1 hour.
The maximum time range for a query is 31 days.
The minimum time granularity for a query is 1 hour.
You can query the data in the last 31 days.

QPS limit

You can call this operation up to five 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	DescribeLiveDelayedStreamingUsage	The operation that you want to perform. Set the value to DescribeLiveDelayedStreamingUsage.
DomainName	String	No	example.com	The domain name. Separate multiple domain names with commas (,). By default, data of all domain names is aggregated and returned.
StartTime	String	No	2022-10-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. By default, data in the last seven days is returned.
EndTime	String	No	2022-10-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 end time must be later than the start time. We recommend that you specify a time range that is less than or equal to 10 hours.
StreamName	String	No	liveStream****	The name of the stream. Separate multiple stream names with commas (,). By default, data of all stream names is aggregated and returned.
Region	String	No	cn-shanghai	The ID of the region. Separate multiple region IDs with commas (,). Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) cn-qingdao: China (Qingdao) ap-southeast-1: Singapore eu-central-1: Germany (Frankfurt) ap-northeast-1: Japan (Tokyo) ap-south-1: India (Mumbai) Closing Down Closing Down ap-southeast-5: Indonesia (Jakarta) If you do not specify this parameter, data of all regions is aggregated and returned by default.
SplitBy	String	No	domain	The key that is used to group data. If you do not specify this parameter, data is aggregated and returned. Valid values: domain: The DomainName parameter is available in the response only if SplitBy is set to domain. region: The Region parameter is available in the response only if SplitBy is set to region. stream: The StreamName parameter is available in the response only if SplitBy is set to stream. Note This parameter takes effect only if the parameter corresponding to the value of this parameter is not left empty. Otherwise, an error is returned. For example, you cannot set this parameter to domain if the DomainName parameter is left empty.
Interval	String	No	3600	The time granularity of the query. Unit: seconds. Valid values: 300 3600 86400 If you specify an invalid value or do not specify this parameter, the default value 3600 is used.

Response parameters

Parameter	Type	Example	Description
EndTime	String	2022-10-10T21:00:00Z	The end of the time range during which the usage data was queried.
StartTime	String	2022-10-10T20:00:00Z	The beginning of the time range during which the usage data was queried.
RequestId	String	4B460F8B-993C-4F48-B98A-910811DEBFEB	The request ID.
DelayData	Array of DelayDataItem		Details about the stream delay usage data.
DelayDataItem
Duration	Long	84	The duration of stream delay.
TimeStamp	String	2022-10-10T20:00:00Z	The timestamp of the data returned.
StreamName	String	liveStream****	The name of the stream. If SplitBy is set to stream, the data generated is grouped by stream.
DomainName	String	example.com	The domain name. If SplitBy is set to domain, the data returned is grouped by domain name.
Region	String	cn-shanghai	The ID of the region. If SplitBy is set to region, the data returned is grouped by region.

Examples

Sample requests

http://live.aliyuncs.com?Action=DescribeLiveDelayedStreamingUsage
&DomainName=www.example.com
&StartTime=2022-10-05T22:00:00Z
&EndTime=2022-10-06T03:00:00Z
&SplitBy=domain

Sample success responses

XML format

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

<DescribeLiveDelayedStreamingUsageResponse>
    <RequestId>b83f5c8c-b07b-4ac8-90c5-96c0f922d394</RequestId>
    <StartTime/>
    <EndTime/>
    <DelayData>
        <DelayDataItem>
            <TimeStamp>2022-11-19T16:00:00Z</TimeStamp>
            <DomainName>www.example.com</DomainName>
            <Duration>60</Duration>
        </DelayDataItem>
        <DelayDataItem>
            <TimeStamp>2022-11-19T17:00:00Z</TimeStamp>
            <DomainName>www.example.com</DomainName>
            <Duration>60</Duration>
        </DelayDataItem>
    </DelayData>
</DescribeLiveDelayedStreamingUsageResponse>

JSON format

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

{
  "RequestId" : "b83f5c8c-b07b-4ac8-90c5-96c0f922d394",
  "StartTime" : "",
  "EndTime" : "",
  "DelayData" : {
    "DelayDataItem" : [ {
      "TimeStamp" : "2022-11-19T16:00:00Z",
      "DomainName" : "www.example.com",
      "Duration" : 60
    }, {
      "TimeStamp" : "2022-11-19T17:00:00Z",
      "DomainName" : "www.example.com",
      "Duration" : 60
    } ]
  }
}

Error codes

HttpCode	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The error message returned because one or more parameters are invalid. Check whether there are invalid parameters based on this topic.
400	InvalidTime.Malformed	Specified Time is malformed.	The error message returned because the format of the specified time is invalid. Check whether the specified time is valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The error message returned because the end time does not match the start time. Check whether the value of the EndTime parameter matches.
400	InvalidTimeSpan	The time span exceeds the limit.	The error message returned because the time range exceeds the limit. Configure a valid time range to query.

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