DescribeRTSNativeSDKFirstFrameDelay

更新时间:
复制 MD 格式

Query the average first frame delay within a specified time period

Operation description

This API is used to query the first frame delay within a specified time range. QPS Limit The single-user QPS limit for this API is 10 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call this API appropriately. For more information, see QPS limits.

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 None

Request parameters

Parameter

Type

Required

Description

Example

StartTime

string

No

Start time. Required parameter. The date format follows ISO 8601 notation and uses UTC+0 time, in the format of yyyy-MM-ddTHH:mm:ssZ.

2021-12-10T20:00:00Z

EndTime

string

No

End time. Required parameter. The date format follows ISO 8601 notation and uses UTC+0 time, in the format of yyyy-MM-ddTHH:mm:ssZ.

2021-12-10T21:00:00Z

DataInterval

string

No

Time granularity. Supported values are 300, 3600, 14400, 28800, and 86400 seconds. If not specified or the specified value is not supported, the default value of 300 seconds is used.

300

DomainNameList

array

No

Queries all domain names by default (version 2.1.0 and above). You can also specify domain names separated by commas (,). A maximum of 500 domain names can be queried at a time.

string

No

Domain name.

a.example.com

Response elements

Element

Type

Description

Example

object

Schema of Response

DataInterval

string

Time granularity.

300

EndTime

string

End time. The date format follows ISO 8601 notation and uses UTC+0 time, in the format of yyyy-MM-ddTHH:mm:ssZ.

2021-12-10T21:00:00Z

FrameDelayData

array<object>

Average first frame delay for each time interval, in milliseconds.

object

FrameDelay

string

Average first frame delay for this time period.

400

TimeStamp

string

Start time of the time slice. The date format follows ISO 8601 notation and uses UTC+0 time, in the format of yyyy-MM-ddTHH:mm:ssZ.

2021-12-10T20:00:00Z

RequestId

string

Id

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

StartTime

string

Start time. The date format follows ISO 8601 notation and uses UTC+0 time, in the format of yyyy-MM-ddTHH:mm:ssZ.

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

Description

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.