Monitor RTMP Live Stream Frame Rate & Bitrate - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Call this operation to query a set of audio and video frame rates and bitrates of an RTMP live stream within a specified time range.
This operation is a monitoring data operation. The data collection and processing method differs from that used for billing. Do not use this operation to calculate usage for billing reconciliation.
You can query historical data within the last 90 days.
Data latency is 3 to 5 minutes.
The maximum time span for a single request is 1 hour.

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:DescribeLiveStreamDetailFrameRateAndBitRateData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs. You can view the AppName on the Stream Management page.	AppName
StreamName	string	Yes	The name of the live stream. You can view the StreamName on the Stream Management page.	exampleStreamName
StartTime	string	No	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC+8).	2017-12-21T08:00:00Z
EndTime	string	No	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC+8). Note If StartTime and EndTime are invalid or not specified, data from the last 1 hour is returned by default.	2017-12-22T08:00:00Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
FrameRateAndBitRateInfos	array<object>	The detailed audio and video frame rate and bitrate data for each time interval.
	object
AudioBitRate	number	The audio bitrate of the live stream. Unit: Bps.	200
AudioFrameRate	number	The audio frame rate of the live stream. Unit: FPS.	60
BitRate	number	The bitrate of the live stream. Unit: Bps.	1420
StreamUrl	string	The URL of the live stream.	rtmp://example.com/AppName/exampleStreamName
Time	string	The statistical time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC+8).	2016-09-13T16:04:00Z
VideoBitRate	number	The video bitrate of the live stream. Unit: Bps.	1200
VideoFrameRate	number	The video frame rate of the live stream. Unit: FPS.	30
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7

Note

The total bitrate of a live stream is collected and calculated differently from the audio bitrate and video bitrate. The sum of the audio bitrate and video bitrate does not necessarily equal the total bitrate. The data returned by this operation is for reference and monitoring purposes only and cannot be used to calculate usage or for billing reconciliation.

Examples

Success response

JSON format

{
  "FrameRateAndBitRateInfos": [
    {
      "AudioBitRate": 200,
      "AudioFrameRate": 60,
      "BitRate": 1420,
      "StreamUrl": "rtmp://example.com/AppName/exampleStreamName",
      "Time": "2016-09-13T16:04:00Z",
      "VideoBitRate": 1200,
      "VideoFrameRate": 30
    }
  ],
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.