DescribeRTSNativeSDKFirstFrameDelay - - Alibaba Cloud Documentation Center

Operation description

Queries the average first-frame delay within a specified time range. A single user can make up to 10 queries per second (QPS). Exceeding this limit triggers throttling, which can affect your business. We recommend that you call this API at a reasonable rate. 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:DescribeRTSNativeSDKFirstFrameDelay

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start 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.	2021-12-10T20:00:00Z
EndTime	string	No	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.	2021-12-10T21:00:00Z
DataInterval	string	No	The time granularity of the data. Unit: seconds. Valid values: 300, 3600, 14400, 28800, and 86400. If you do not set this parameter or specify an invalid value, the default value 300 is used.	300
DomainNameList	array	No	A list of domain names to query. Separate multiple domain names with a comma (,). You can query up to 500 domain names at a time. If you use version 2.1.0 or later and leave this parameter empty, data for all your domain names is returned.
	string	No	A domain name.	a.example.com

Response elements

Element	Type	Description	Example
	object	The response schema.
DataInterval	string	The time granularity of the data. Unit: seconds.	300
EndTime	string	The end of the time range.	2021-12-10T21:00:00Z
FrameDelayData	array<object>	The average first-frame delay for each time interval. Unit: milliseconds.
	object
FrameDelay	string	The average first-frame delay in the time interval.	400
TimeStamp	string	The start of the time interval.	2021-12-10T20:00:00Z
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StartTime	string	The start of the time range.	2021-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "DataInterval": "300",
  "EndTime": "2021-12-10T21:00:00Z",
  "FrameDelayData": [
    {
      "FrameDelay": "400",
      "TimeStamp": "2021-12-10T20:00:00Z"
    }
  ],
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "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.