Queries the frame rates and bitrates of a live stream that is based on Real Time Messaging Protocol (RTMP) in a specified time period. You can call this operation to query historical data.

Note This operation can be called up to 50 times per second.

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 DescribeLiveStreamBitRateData

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

AppName String Yes testApp

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

DomainName String Yes www.yourdomain.com

The ingest domain.

StreamName String Yes testStream

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://play.aliyunlive.com/AppName/StreamName

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: Kbit/s.

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=testApp
&DomainName=www.example.com
&StreamName=testStream
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveStreamBitRateDataResponse>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <FrameRateAndBitRateInfos>
        <FrameRateAndBitRateInfo>
              <Time>2016-09-13T16:04:00Z</Time>
              <BitRate>600</BitRate>
              <AudioFrameRate>100</AudioFrameRate>
              <StreamUrl>rtmp://play.aliyunlive.com/AppName/StreamName </StreamUrl>
              <VideoFrameRate>30</VideoFrameRate>
        </FrameRateAndBitRateInfo>
  </FrameRateAndBitRateInfos>
</DescribeLiveStreamBitRateDataResponse>

JSON format

{
	"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
	"FrameRateAndBitRateInfos": {
		"FrameRateAndBitRateInfo": [{
			"Time": "2016-09-13T16:04:00Z",
			"BitRate": "600",
			"AudioFrameRate": "100",
			"StreamUrl": "rtmp://play.aliyunlive.com/AppName/StreamName ",
			"VideoFrameRate": "30"
		}]
	}
}

Error codes

HttpCode 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 correct.
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 correct.

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