DescribeLiveDomainStreamTranscodeData - ApsaraVideo Live

Queries the transcoding usage data for one or more domain names.

Usage notes

You can call this operation to collect the transcoding usage data at each time interval.
You can specify multiple domain names by separating them with commas (,).
You can query data in the last 90 days.
The time granularity of data is 1 hour or 1 day.
For information about the billing of different transcoding types and transcoding resolutions, see the description about billing of different transcoding specifications in transcoding bills in the Billing of live stream transcoding section of the ApsaraVideo Live pricing page.

QPS limit

You can call this operation up to 20 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	DescribeLiveDomainStreamTranscodeData	The operation that you want to perform. Set the value to DescribeLiveDomainStreamTranscodeData.
DomainName	String	No	example.com	The main streaming domain for which you want to query data. If you do not specify this parameter, the data for all your domain names is returned. You can specify multiple domain names by separating them with commas (,).
StartTime	String	Yes	2017-12-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. The minimum time granularity is 1 hour. If you do not specify this parameter, the data in the last 24 hours is returned.
EndTime	String	Yes	2017-12-10T22: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.
Precision	String	No	min	The time precision of the query. Valid values: min (default): in minutes. sec: in seconds.
Interval	String	No	3600	The time granularity of the query. Unit: seconds. Valid values: 3600: 1 hour 86400: 1 day Note If you do not specify this parameter, the time granularity of 1 hour is used by default.
Split	String	No	domain	The key that is used to group data. Valid values: domain: The Domain parameter in the response takes effect only if Split is set to domain. region: The Region parameter in the response takes effect only if Split is set to region. transcode_type: The TanscodeType parameter in the response takes effect only if Split is set to transcode_type. resolution: The Resolution parameter in the response takes effect only if Split is set to resolution. fps: The Fps parameter in the response takes effect only if Split is set to fps. You can specify one or more keys. If you specify multiple keys, separate them with commas (,). Default value: `domain,region,transcode_type,resolution,fps`.

Response parameters

Parameter	Type	Example	Description
RequestId	String	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F	The request ID.
TranscodeDataList	Array of TranscodeData		The transcoding usage data returned at each interval.
TranscodeData
TanscodeType	String	H264STD	The transcoding type. Valid values: Note This parameter takes effect only if the request parameter Split is set to transcode_type. H264STD: standard transcoding based on H.264 H264NBHD: Narrowband HD™ transcoding based on H.264 H265STD: standard transcoding based on H.265 AUDIO: audio transcoding
Domain	String	example.com	The main streaming domain. Note This parameter takes effect only if the request parameter Split is set to domain.
Region	String	cn-beijing	The ID of the region in which the domain name resides. Valid values: Note This parameter takes effect only if the request parameter Split is set to region. cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-shenzhen: China (Shenzhen) ap-northeast-1: Japan (Tokyo) ap-southeast-1: Singapore ap-southeast-5: Indonesia (Jakarta) eu-central-1: Germany (Frankfurt)
Duration	Integer	2000	The duration. Unit: minutes.
TimeStamp	String	2017-12-10T20:00:00Z	The timestamp of the data returned.
Fps	String	normal	The frame rate. Note This parameter takes effect only if the request parameter Split is set to fps.
Resolution	String	HD	The resolution. Valid values: Note This parameter takes effect only if the request parameter Split is set to resolution. 2K 4K LD: low definition SD: standard definition HD: high definition def: audio

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainStreamTranscodeData
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T22:00:00Z
&<Common request parameters>

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainStreamTranscodeDataResponse>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
<TranscodeDataList>
    <TranscodeData>
        <Fps>normal</Fps>
        <Region>cn-beijing</Region>
        <Duration>2000</Duration>
        <TanscodeType>H264STD</TanscodeType>
        <Domain>example.com</Domain>
        <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
        <Resolution>HD</Resolution>
    </TranscodeData>
</TranscodeDataList>
</DescribeLiveDomainStreamTranscodeDataResponse>

JSON format

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

{
  "DescribeLiveDomainStreamTranscodeDataResponse" : {
    "RequestId" : "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "TranscodeDataList" : {
      "TranscodeData" : {
        "Fps" : "normal",
        "Region" : "cn-beijing",
        "Duration" : 2000,
        "TanscodeType" : "H264STD",
        "Domain" : "example.com",
        "TimeStamp" : "2017-12-10T20:00:00Z",
        "Resolution" : "HD"
      }
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	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 format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400	InvalidParamPrecision	The parameter Precision is invalid, please check StartTime and EndTime or Precision.	The Precision parameter is invalid. Check the value of the StartTime, EndTime, or Precision parameter.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	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 time range exceeds the limit. Configure a valid time range to query.
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.

Special 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 domain name does not exist or does not belong to your account.