DescribeLiveInteractionMetricData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries ApsaraVideo Real-time Communication (ARTC) metric data.

Operation description

You can query data from the last 30 days. The time range for a single query cannot exceed 24 hours.
The data granularity is 5 minutes.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
MetricType	string	Yes	Metric type. Valid values: JoinChannelSucRate: Success rate of joining a channel within 5 seconds. VideoStuckRate: Video stuttering rate. AudioStuckRate: Audio stuttering rate. FirstFrameCost: Time to first frame.	FirstFrameCost
BeginTs	integer	Yes	The start time of the query, represented as a UNIX timestamp in milliseconds.	1698195600000
EndTs	integer	Yes	The end time of the query, represented as a UNIX timestamp in milliseconds.	1698201013000
Os	string	No	Operating system. Valid values: iOS, Android.	Android
TerminalType	string	No	Terminal type. Valid values: web, mobile.	mobile
AppId	string	Yes	ARTC application ID.	e4d7f08a-01fe-41b5-a091-fe41060a****

Response elements

Element	Type	Description	Example
	object	Response parameters.
Nodes	array<object>	Node data.
	object	Node data.
Timestamp	string	The timestamp for the data point, represented as a UNIX timestamp in milliseconds.	1548670257000
Value	string	Value of the metric.	66.670000
RequestId	string	Request ID.	A01C98C5-25AE-124A-83FE-514DF5C5BE36
SummaryData	string	The summarized data for the queried time range.	2000

Examples

Success response

JSON format

{
  "Nodes": [
    {
      "Timestamp": "1548670257000",
      "Value": "66.670000"
    }
  ],
  "RequestId": "A01C98C5-25AE-124A-83FE-514DF5C5BE36",
  "SummaryData": "2000"
}

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.