DescribeEndPointMetricData_音视频通信_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

本接口用于获取端对端指标数据。例如:您可以获取订阅端和发布端的指标信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rtc:DescribeEndPointMetricData
Get
全部资源
*

请求参数

字段名称字段详情
AppIdstring

APP ID。

示例值:testappid
ChannelIdstring

频道 ID

示例值:testid参考取值来源:
    DescribeRtcChannelList
CreatedTsinteger<int64>

查询时间区间的开始时间,该时间不得早于频道实际的创建时间,不得早于 30 天之前。使用 UNIX 时间戳表示,单位:秒。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1614936817
DestroyedTsinteger<int64>

查询时间区间的结束时间,该时间不得晚于频道释放时间。使用 UNIX 时间戳表示,单位:秒。参数为空,表示获取当前时间。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1614936817
SubUserIdstring

订阅端用户 ID。

示例值:testuserid
PubUserIdstring

发布端用户 ID。展开详情

示例值:testuserid2
PubCallIdListstring

发布端用户通信流的 Call ID,多个用英文逗号(,)分隔。展开详情

示例值:testcall1,testcall2
Metricsstring

指标枚举列表,多个用英文逗号(,)分隔。

示例值:VIDEO_STUCK_CAMERA参考取值来源:
    DescribeChannelUserMetrics

请求说明

指标如下所示:

名称说明
APP_CPUAPP 占用 CPU。
SYSTEM_CPU系统占用 CPU。
APP_MEMORYAPP 占用内存。
SYSTEM_MEMORY系统占用内存。
SYSTEM_TOTAL_MEMORY系统总内存。
AUDIO_LOST_RATE音频丢包率。
VIDEO_LOST_RATE视频丢包率。
AUDIO_RTT音频延时。
VIDEO_RTT视频延时。
AUDIO_BIT_RATE音频码率。
AUDIO_STUCK音频卡顿。
AUDIO_LEVEL音量。
VIDEO_BIT_RATE_CAMERA摄像头视频码率。
VIDEO_BIT_RATE_SHARE视频码率(屏幕分享)。
VIDEO_STUCK_CAMERA摄像头视频卡顿。
VIDEO_STUCK_SHARE视频卡顿(屏幕分享)。
VIDEO_RESOLUTION_CAMERA摄像头视频分辨率。
VIDEO_RESOLUTION_SHARE视频分辨率(屏幕分享)。
VIDEO_FPS_CAMERA摄像头视频帧率。
VIDEO_FPS_SHARE视频帧率(屏幕分享)。

返回参数

字段名称字段详情
SubMetricsarray<object>

订阅端用户指标数据。

PubMetricsarray<object>

发布端用户指标数据。

RequestIdstring

请求 ID。

示例值:231470C1-ACFB-4C9F-844F-4CFE1E3804C5

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
ApiParamError
API %s.诊断
403
BizAppError
A business application permission error occurred.诊断
403
BizUidError
A business UID error occurred.诊断
403
BizCreatedTsError
A business CreatedTs error occurred.诊断
500
ServerInternalError
An internal error occurred.诊断

变更历史

变更时间变更内容概要操作
2024-05-09
变更错误码403

相关示例