Queries the frame rates and bitrates of a live stream that is based on Real-Time Messaging Protocol (RTMP) in a specified time period.
Operation description
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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeLiveStreamBitRateData | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DomainName | string | Yes | The ingest domain. | demo.aliyundoc.com |
| AppName | string | Yes | The name of the application to which the live stream belongs. | liveApp**** |
| StreamName | string | Yes | The name of the live stream. | liveStream**** |
| StartTime | string | No | 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. | 2017-12-21T08:00:00Z |
| EndTime | string | No | 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. | 2017-12-22T08:00:00Z |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"FrameRateAndBitRateInfos": {
"FrameRateAndBitRateInfo": [
{
"Time": "2016-09-13T16:04:00Z",
"VideoFrameRate": 30,
"AudioFrameRate": 100,
"StreamUrl": "rtmp://guide.aliyundoc.com/liveAppName****/liveSteamName****",
"BitRate": 600
}
]
}
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidAppName.Malformed | Specified AppName is malformed. |
| 400 | InvalidStreamName.Malformed | Specified StreamName is malformed. |
| 400 | InvalidStreamNumber.Malformed | %s |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. |
| 400 | InvalidTime.ValueNotSupported | %s |
| 400 | InvalidTime.Malformed | %s |
| 400 | InvalidTime.ValueNotSupported | StartTime or EndTime is miss match. |
For a list of error codes, visit the Service error codes.