Queries the frame rates and bitrates of a live stream that is based on Real-Time Messaging Protocol (RTMP) in a specified time period.

Usage note

You can call this operation to query historical data. You can specify the StartTime and EndTime in the request to narrow down the query scope.

QPS limit

A single user can perform a maximum of 50 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

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveStreamBitRateData

The operation that you want to perform. Set the value to DescribeLiveStreamBitRateData.

AppName String Yes liveApp****

The name of the application to which the live stream belongs.

DomainName String Yes demo.aliyundoc.com

The ingest domain.

StreamName String Yes liveStream****

The name of the live stream.

StartTime String No 2017-12-21T08: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.

EndTime String No 2017-12-22T08: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.

Response parameters

Parameter Type Example Description
FrameRateAndBitRateInfos Array of FrameRateAndBitRateInfo

The frame rates and bitrates of the live stream.

FrameRateAndBitRateInfo
StreamUrl String rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****

The URL of the live stream.

VideoFrameRate Float 30

The video frame rate of the live stream. Unit: FPS.

AudioFrameRate Float 100

The audio frame rate of the live stream. Unit: FPS.

BitRate Float 600

The bitrate of the live stream. Unit: Bps

Time String 2016-09-13T16:04:00Z

The time when the statistics were collected. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamBitRateData
&AppName=liveApp****
&DomainName=demo.aliyundoc.com
&StreamName=liveStream****
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamBitRateDataResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <FrameRateAndBitRateInfos>
            <FrameRateAndBitRateInfo>
                  <VideoFrameRate>30</VideoFrameRate>
                  <Time>2016-09-13T16:04:00Z</Time>
                  <BitRate>600</BitRate>
                  <AudioFrameRate>100</AudioFrameRate>
                  <StreamUrl>rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****</StreamUrl>
            </FrameRateAndBitRateInfo>
      </FrameRateAndBitRateInfos>
</DescribeLiveStreamBitRateDataResponse>

JSON format

{
    "DescribeLiveStreamBitRateDataResponse": {
        "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
        "FrameRateAndBitRateInfos": {
            "FrameRateAndBitRateInfo": [
                {
                    "VideoFrameRate": 30,
                    "Time": "2016-09-13T16:04:00Z",
                    "BitRate": 600,
                    "AudioFrameRate": 100,
                    "StreamUrl": "rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****"
                }
            ]
        }
    }
}

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.

For a list of error codes, visit the API Error Center.