DescribeRTSNativeSDKPlayFailStatus - - Alibaba Cloud Documentation Center

Queries the status codes for playback failures that occurred within a specified time range.

Operation description

This API operation queries the status codes for playback failures that occurred within a specified time range. The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate. 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:DescribeRTSNativeSDKPlayFailStatus

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start time. The time must be in ISO 8601 format and in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2021-12-10T20:00:00Z
EndTime	string	No	The end time. The time must be in ISO 8601 format and in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2021-12-10T21:00:00Z
DataInterval	string	No	The time granularity. Valid values: 300, 3600, 14400, 28800, and 86400. Unit: seconds. If you do not specify this parameter or specify an invalid value, the default value of 300 is used.	300
DomainNameList	array	No	By default, data for all domain names is queried for SDK versions 2.1.0 and later. You can also specify one or more domain names. Separate multiple domain names with commas (,). You can query up to 500 domain names at a time.
	string	No	A 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.	2021-12-10T21:00:00Z
PlayFailStatus	array<object>	The total count of error status codes for each time interval.
	object
TimeStamp	string	The start of the time interval.	2021-12-10T20:00:00Z
V20001	string	DNS resolution failed.	1
V20002	string	Authentication failed.	2
V20011	string	Connection signaling timeout.	3
V20012	string	An error occurred during subscription signaling.	4
V20013	string	The subscribed stream does not exist.	5
V20052	string	Media package reception timeout.	6
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StartTime	string	The start time.	2021-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "DataInterval": "300",
  "EndTime": "2021-12-10T21:00:00Z",
  "PlayFailStatus": [
    {
      "TimeStamp": "2021-12-10T20:00:00Z",
      "V20001": "1",
      "V20002": "2",
      "V20011": "3",
      "V20012": "4",
      "V20013": "5",
      "V20052": "6"
    }
  ],
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StartTime": "2021-12-10T20:00:00Z\n"
}

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.