DescribeLiveDomainFrameRateAndBitRateData - ApsaraVideo Live

Queries the frame rates and bitrates of all live streams under an ingest domain.

Operation description

Usage notes

You can call this operation to query the real-time bitrates and frame rates of live streams, which helps you evaluate the stream ingest quality. A delay exists in data collection and statistics. We recommend that you query the data of more than 5 minutes ago.

Note Use this operation to replace the deprecated DescribeLiveStreamsFrameRateAndBitRateData operation.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:DescribeLiveDomainFrameRateAndBitRateData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
QueryTime	string	Yes	The point of time to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-02-21T08:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	C3F2C2C4-59BB-4B62-81FF-345BE557E3E3
FrameRateAndBitRateInfos	array<object>	The frame rates and bitrates of the live streams that were queried.
FrameRateAndBitRateInfo	object
VideoFrameRate	float	The video frame rate of the live stream. Unit: frames per second (FPS).	24.9
StreamUrl	string	The URL of the live stream.	rtmp://demo.aliyundoc.com/test/liveStream****_3_4
AudioFrameRate	float	The audio frame rate of the live stream. Unit: FPS.	42.9
BitRate	float	The bitrate of the live stream. Unit: bit/s.	30693.96

Examples

Sample success responses

JSONformat

{
  "RequestId": "C3F2C2C4-59BB-4B62-81FF-345BE557E3E3",
  "FrameRateAndBitRateInfos": {
    "FrameRateAndBitRateInfo": [
      {
        "VideoFrameRate": 24.9,
        "StreamUrl": "rtmp://demo.aliyundoc.com/test/liveStream****_3_4",
        "AudioFrameRate": 42.9,
        "BitRate": 30693.96
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to backend service exception.	-
400	InvalidQueryTime.Exceed	QueryTime exceed three month.	The query time is more than three months from the current time.
400	InvalidQueryTime.Malformed	Specified QueryTime is malformed.	The specified query time is invalid.

For a list of error codes, visit the Service error codes.