Queries the transcoding length for one or more domain names.

Usage note

  • You can specify multiple domain names and separate them with commas (,).
  • You can query the transcoding length within the last 90 days.
  • The data is queried by hour or day.
  • For information about the billing rules for transcoding that involves different output resolutions and transcoding types, see the pricing tiers for different transcoding specifications on the pricing page of ApsaraVideo Live.

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

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.

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 query interval is 1 hour.
  • If you do not set this parameter, the transcoding length for 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.

DomainName String No example.com

The main streaming domain for which you want to query the transcoding length.

  • If you do not set this parameter, the transcoding length for all your domain names is returned.
  • You can specify multiple domain names and separate them with commas (,).
Split String No domain

The key that is used to group data. Valid values:

  • domain: the domain name.
  • region: the region that is used as the live center of ApsaraVideo Live.
  • transcode_type: the transcoding type.
  • resolution: the resolution of the transcoded stream.
  • fps: the frame rate of the transcoded stream.

You can specify one or more keys. If you specify multiple keys, separate them with commas (,).

Default value: domain,region,transcode_type,resolution,fps.

Interval String No 3600

The interval at which the transcoding length is to be queried. Unit: seconds. Valid values:

  • 3600: Query the transcoding length by hour.
  • 86400: Query the transcoding length by day.

If you do not set this parameter, the transcoding length is queries by hour.

Response parameters

Parameter Type Example Description
RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

The ID of the request.

TranscodeDataList Array of TranscodeData

The data that was collected for each interval.

TranscodeData
Domain String example.com

The main streaming domain. This parameter is returned only when you add the domain key to the value of the Split parameter.

Duration Integer 2000

The transcoding length. Unit: minutes.

Fps String normal

The frame rate of the transcoded stream. This parameter is returned only when you add the fps key to the value of the Split parameter.

Region String cn-beijing

The region that is used as the live center of ApsaraVideo Live. This parameter is returned only when you add the region key to the value of the Split parameter. Valid values:

  • cn-beijing: China (Beijing)
  • cn-shanghai: China (Shanghai)
  • cn-qingdao: China (Qingdao)
  • cn-shenzhen: China (Shenzhen)
  • ap-northeast-1: Japan (Tokyo)
  • ap-south-1: India (Mumbai)
  • ap-southeast-1: Singapore (Singapore)
  • ap-southeast-5: Indonesia (Jakarta)
  • eu-central-1: Germany (Frankfurt)
Resolution String HD

The resolution of the transcoded stream. This parameter is returned only when you add the resolution key to the value of the Split parameter. Valid values:

  • 2K
  • 4K
  • LD: low definition
  • SD: standard definition
  • HD: high definition
  • def: audio
TanscodeType String H264STD

The transcoding type. This parameter is returned only when you add the transcode_type key to the value of the Split parameter. Valid values:

  • 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
TimeStamp String 2017-12-10T20:00:00Z

The timestamp of the data entry.

Examples

Sample requests

##Sample request without the Split parameter
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainStreamTranscodeData
&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T22:00:00Z
&<Common request parameters>

##Sample request with the Split parameter

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

Sample success responses

XML format 

##Sample response without the Split parameter
<TranscodeDataList>
    <TranscodeData>
        <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
        <Domain>example.com</Domain>
        <Region>cn-beijing</Region>
        <TranscodeType>H264STD</TranscodeType>
        <Resolution>HD</Resolution>
        <Fps>normal</Fps>
        <Duration>2000</Duration>
    </TranscodeData>
    <TranscodeData>
        <TimeStamp>2017-12-10T21:00:00Z</TimeStamp>
        <Domain>example.com</Domain>
        <Region>cn-beijing</Region>
        <TranscodeType>H264STD</TranscodeType>
        <Resolution>HD</Resolution>
        <Fps>normal</Fps>
        <Duration>2000</Duration>
    </TranscodeData>
</TranscodeDataList>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>

##Sample response with the Split parameter
<TranscodeDataList>
    <TranscodeData>
        <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
        <Duration>2000</Duration>
        <Domain>example.com</Domain>
    </TranscodeData>
    <TranscodeData>
        <TimeStamp>2017-12-10T21:00:00Z</TimeStamp>
        <Duration>1000</Duration>
        <Domain>example.com</Domain>
    </TranscodeData>
    <TranscodeData>
        <TimeStamp>2017-12-10T21:00:00Z</TimeStamp>
        <Duration>1000</Duration>
        <Domain>example.com</Domain>
    </TranscodeData>
</TranscodeDataList>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>

JSON format 

##Sample response without the Split parameter
{
    "TranscodeDataList": {
        "TranscodeData": [
            {
                "TimeStamp": "2017-12-10T20:00:00Z",
                "Domain": "example.com",
                "Region": "cn-beijing",
                "TranscodeType": "H264STD",
                "Resolution": "HD",
                "Fps": "normal",
                "Duration": "2000"
            },
            {
                "TimeStamp": "2017-12-10T21:00:00Z",
                "Domain": "example.com",
                "Region": "cn-beijing",
                "TranscodeType": "H264STD",
                "Resolution": "HD",
                "Fps": "normal",
                "Duration": "2000"
            }
        ]
    },
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F"
}

##Sample response with the Split parameter
{
    "TranscodeDataList": {
        "TranscodeData": [
            {
                "TimeStamp": "2017-12-10T20:00:00Z",
                "Duration": "2000",
                "Domain": "example.com"
            },
            {
                "TimeStamp": "2017-12-10T21:00:00Z",
                "Duration": "1000",
                "Domain": "example.com"
            },
            {
                "TimeStamp": "2017-12-10T21:00:00Z",
                "Duration": "1000",
                "Domain": "aliyundoc.com"
            }
        ]
    },
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F"
}

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 your Alibaba Cloud account.