Queries the frame rates and bitrates of all the live streams under an ingest domain.
Usage note
A latency exists in data collection and statistics. We recommend that you query the data generated at least 5 minutes ago.
The DescribeLiveStreamsFrameRateAndBitRateData operation, which was available in earlier versions, is deprecated.
QPS limit
A single user can perform a maximum of 100 queries per second (QPS). 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 | DescribeLiveDomainFrameRateAndBitRateData |
The operation that you want to perform. Set the value to DescribeLiveDomainFrameRateAndBitRateData. |
DomainName | String | Yes | demo.aliyundoc.com |
The ingest domain. |
QueryTime | String | Yes | 2019-02-21T08:00:00Z |
The time to implement the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
FrameRateAndBitRateInfos | Array of FrameRateAndBitRateInfo |
The frame rates and bitrates of the live streams that were queried. |
|
FrameRateAndBitRateInfo | |||
AudioFrameRate | Float | 42.9 |
The audio frame rate of the live stream. Unit: FPS. |
BitRate | Float | 30693.96 |
The bitrate of the live stream. Unit: Bps |
StreamUrl | String | rtmp://demo.aliyundoc.com/test/liveStream****_3_4 |
The URL of the live stream. |
VideoFrameRate | Float | 24.9 |
The video frame rate of the live stream. Unit: FPS. |
RequestId | String | C3F2C2C4-59BB-4B62-81FF-345BE557E3E3 |
The ID of the request. |
Examples
Sample requests
http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainFrameRateAndBitRateData
&DomainName=demo.aliyundoc.com
&QueryTime=2019-02-21T08:00:00Z
&<Common request parameters>
Sample success responses
XML
format
<DescribeLiveDomainFrameRateAndBitRateDataResponse>
<RequestId>C3F2C2C4-59BB-4B62-81FF-345BE557E3E3</RequestId>
<FrameRateAndBitRateInfos>
<FrameRateAndBitRateInfo>
<VideoFrameRate>24.9</VideoFrameRate>
<BitRate>30693.96</BitRate>
<AudioFrameRate>42.9</AudioFrameRate>
<StreamUrl>rtmp://demo.aliyundoc.com/test/liveStream****_3_4</StreamUrl>
</FrameRateAndBitRateInfo>
</FrameRateAndBitRateInfos>
</DescribeLiveDomainFrameRateAndBitRateDataResponse>
JSON
format
{
"DescribeLiveDomainFrameRateAndBitRateDataResponse": {
"RequestId": "C3F2C2C4-59BB-4B62-81FF-345BE557E3E3",
"FrameRateAndBitRateInfos": {
"FrameRateAndBitRateInfo": {
"VideoFrameRate": 24.9,
"BitRate": 30693.96,
"AudioFrameRate": 42.9,
"StreamUrl": "rtmp://demo.aliyundoc.com/test/liveStream****_3_4"
}
}
}
}
Error codes
For a list of error codes, visit the API Error Center.