All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveInteractionMetricData

Last Updated:Nov 14, 2024

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

Operation description

Usage notes

  • You can query data in the last 30 days. The time range for a query cannot exceed 24 hours.
  • The time granularity for a query 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 will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveInteractionMetricDatanone
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MetricTypestringYes

The metric. Valid values:

  • JoinChannelSucRate: the success rate of joining a channel within 5 seconds.
  • VideoStuckRate: the video stuttering rate.
  • AudioStuckRate: the audio stuttering rate.
  • FirstFrameCost: the time to first frame.
FirstFrameCost
BeginTslongYes

The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.

1698195600000
EndTslongYes

The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.

1698201013000
OsstringNo

The operating system. Valid values: iOS and Android.

Android
TerminalTypestringNo

The terminal type. Valid values: web and mobile.

mobile
AppIdstringYes

The ID of the application.

e4d7f08a-01fe-41b5-a091-fe41060a****

Response parameters

ParameterTypeDescriptionExample
object
Nodesarray<object>

The node data.

Dataobject
Timestampstring

The time when the metric was queried. The value is a UNIX timestamp. Unit: milliseconds.

1548670257000
Valuestring

The value of the metric.

66.670000
RequestIdstring

The ID of the request.

A01C98C5-25AE-124A-83FE-514DF5C5BE36
SummaryDatastring

The summary data.

2000

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Meter.ParamErrorParam Error:%s,Please Check Again.
403Meter.AuthErrorAuthentication Failed,Please Try Again.
500Meter.ServerInternalErrorThe Request Processing Has Failed Due To Some Unknown Error.
500Meter.DataSourceQueryErrorData Source Error:%s,Please Try Again.
502Meter.ReadyTsErrorGet ReadyTs Failed,Please Try Again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history