DescribeLiveCenterStreamRateData API Reference - ApsaraVideo Live

Operation description

The time granularity for the returned data is 5 seconds. The maximum time range to query is 3 hours. You can query data in the last 30 days.

QPS limit

You can call this operation up to 50 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.

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

none

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
AppName	string	Yes	The name of the application to which the live stream belongs. You can view the application name on the Stream Management page of the ApsaraVideo Live console.	liveApp****
DomainName	string	Yes	The ingest domain.	demo.aliyundoc.com
StreamName	string	Yes	The name of the live stream. You can view the stream name on the Stream Management page of the ApsaraVideo Live console.	liveStream****
StartTime	string	Yes	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.	2024-03-05T18:00:53Z
EndTime	string	Yes	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.	2024-03-05T18:01:03Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
RateDatas	array<object>	The list of frame rates and bitrates.
	object
AudioFps	string	The audio frame rate.	47
AudioRate	string	The audio bitrate.	600
Time	string	The time when the data was collected. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-03-05T18:00:53Z
VideoFps	string	The video frame rate.	30
VideoRate	string	The video bitrate.	1953584
RequestId	string	The request ID.	B6E125BE-E9B8-1103-8684-A35*******

Examples

Success response

JSON format

{
  "RateDatas": [
    {
      "AudioFps": "47",
      "AudioRate": "600",
      "Time": "2024-03-05T18:00:53Z",
      "VideoFps": "30",
      "VideoRate": "1953584"
    }
  ],
  "RequestId": "B6E125BE-E9B8-1103-8684-A35*******"
}

Error codes

HTTP status code	Error code	Error message
400	Meter.ParamError	Param Error:%s,Please Check Again.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.
403	Meter.AuthError	Authentication Failed,Please Try Again.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.