DescribeLiveStreamBitRateData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the frame rates and bitrates of a Real-Time Messaging Protocol (RTMP) live stream within a specified time range. This operation retrieves historical data.

QPS limit

The queries per second (QPS) limit for this operation is 50 calls per second per user. If you exceed the limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveStreamBitRateData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain. Note Ensure the domain is used for live streaming and you have permission to access it.	demo.aliyundoc.com
AppName	string	Yes	The name of the application. For more information, see Stream management.	liveApp****
StreamName	string	Yes	The name of the stream. For more information, see Stream management.	liveStream****
StartTime	string	No	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-21T08:00:00Z
EndTime	string	No	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note The end time must be later than the start time. The maximum time range that can be queried is 30 days.	2017-12-22T08:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
FrameRateAndBitRateInfos	object
FrameRateAndBitRateInfo	array<object>	The frame rate and bitrate of each live stream.
	object	The frame rate and bitrate of each live stream.
Time	string	The timestamp of the data. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-09-13T16:04:00Z
VideoFrameRate	number	The video frame rate of the live stream. Unit: fps.	30
AudioFrameRate	number	The audio frame rate of the live stream. Unit: fps.	100
StreamUrl	string	The URL of the live stream.	rtmp://guide.aliyundoc.com/liveAppName**/liveSteamName**
BitRate	number	The bitrate of the live stream. Unit: bps.	600

Examples

Success response

JSON format

{
  "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	Description
400	InvalidAppName.Malformed	Specified AppName is malformed.
400	InvalidStreamName.Malformed	Specified StreamName is malformed.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidTime.ValueNotSupported	StartTime or EndTime is miss match.
400	InvalidStreamNumber.Malformed	%s, please check and try again later.	Invalid number of streams, please check and try again.
400	InvalidTime.Malformed	%s, please check and try again later.	Invalid StartTime and EndTime interval, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.