RTS Native SDK First-Frame Latency Metrics Overview - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Retrieves the first frame latency composition within a specified time period.

Operation description

Queries the first frame latency composition within a specified time range. QPS limit: The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency. For more information, see QPS limit.

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

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start time. This parameter is required. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2021-12-10T20:00:00Z
EndTime	string	No	The end time. This parameter is required. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2021-12-10T21:00:00Z
DataInterval	string	No	The time granularity. Valid values: 300, 3600, 14400, 28800, and 86400. Unit: seconds. If this parameter is not specified or the specified value is not supported, the default value 300 is used.	300
DomainNameList	array	No	By default, all domain names are queried (version 2.1.0 and later). You can also specify domain names. Separate multiple domain names with commas (,). A maximum of 500 domain names can be queried at a time.
	string	No	The domain name.	a.example.com

Response elements

Element	Type	Description	Example
	object	Schema of Response
DataInterval	string	The time granularity.	300
EndTime	string	The end time. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-10T21:00:00Z
FirstFrameCostData	array<object>	The average first frame latency composition for each time interval. Unit: milliseconds.
	object
Connected	string	The time elapsed from successful initialization to successful connection establishment.	100
FinishGetStreamInfo	string	The time elapsed from successful connection establishment to successful subscription.	89
FirstFrameComplete	string	The time elapsed from receiving the first packet to rendering the first frame.	32
FirstPacket	string	The time elapsed from successful subscription to receiving the first packet.	132
Initialized	string	The initialization duration.	1100
TimeStamp	string	The start time of the time interval. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-10T20:00:00Z
RequestId	string	Id	BC858082-736F-4A25-867B-E5B67C85ACF7
StartTime	string	The start time. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "DataInterval": "300",
  "EndTime": "2021-12-10T21:00:00Z",
  "FirstFrameCostData": [
    {
      "Connected": "100",
      "FinishGetStreamInfo": "89",
      "FirstFrameComplete": "32",
      "FirstPacket": "132",
      "Initialized": "1100",
      "TimeStamp": "2021-12-10T20:00:00Z"
    }
  ],
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
  "StartTime": "2021-12-10T20:00:00Z"
}

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.