DescribeLiveDomainFrameRateAndBitRateData - ApsaraVideo Live

Operation description

You can call this operation to query the real-time bitrate and frame rate of ingest streams to monitor the quality of upstream stream ingest. Data collection and statistics are subject to a delay. Query data that is at least five minutes old.

Note

Use this operation to replace the deprecated DescribeLiveStreamsFrameRateAndBitRateData operation.

QPS limit

The queries per second (QPS) limit for a single user is 100. If you exceed this limit, API calls are throttled. Because throttling can affect your business, call this operation at a reasonable rate.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	Yes	An ingest domain. Note The domain must be an ingest domain for live streaming that you have permission to manage.	demo.aliyundoc.com
QueryTime	string	Yes	The time to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2019-02-21T08:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	C3F2C2C4-59BB-4B62-81FF-345BE557E3E3
FrameRateAndBitRateInfos	object
FrameRateAndBitRateInfo	array<object>	A list of frame rate and bitrate data.
	object	The live stream's frame rate and bitrate.
VideoFrameRate	number	The video frame rate of the stream, in frames per second (fps).	24.9
StreamUrl	string	The URL of the stream.	rtmp://demo.aliyundoc.com/test/liveStream****_3_4
AudioFrameRate	number	The audio frame rate of the stream, in frames per second (fps).	42.9
BitRate	number	The bitrate of the stream, in bytes per second (Bps).	30693.96

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.