调用DescribeEndPointMetricData获取端对端指标数据_音视频通信(RTC)-阿里云帮助中心

使用说明

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

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /api/call/describeEndPointMetricData HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
AppId	String	Query	是	9qb1****	App ID，可通过控制台创建和查询。
ChannelId	String	Query	是	311	频道ID。
CreatedTs	Long	Query	是	1615887685	创建频道时间，支持查询最近30天的数据。使用UNIX时间戳表示，单位：秒。
DestroyedTs	Long	Query	否	1615888615	释放频道时间，使用UNIX时间戳表示，单位：秒。参数为空表示获取当前时间。说明如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据，且最多返回最近3个小时的数据。
SubUserId	String	Query	否	testsubuserid	订阅端用户ID。
PubUserId	String	Query	否	c906531af5f9****	发布端用户ID。说明 PubUserId和PubCallIdList参数只能二选一输入。
PubCallIdList	String	Query	否	testcall1,testcall2	发布端用户通信流的Call ID，多个用英文逗号（,）分隔。说明 PubUserId和PubCallIdList参数只能二选一输入。
Metrics	String	Query	是	APP_CPU,SYSTEM_CPU	指标枚举列表，多个用英文逗号（,）分隔。

指标如下所示：


名称	说明
APP_CPU	APP占用CPU。
SYSTEM_CPU	系统占用CPU。
APP_MEMORY	APP占用内存。
SYSTEM_MEMORY	系统占用内存。
SYSTEM_TOTAL_MEMORY	系统总内存。
AUDIO_LOST_RATE	音频丢包率。
VIDEO_LOST_RATE	视频丢包率。
AUDIO_RTT	音频延时。
VIDEO_RTT	视频延时。
AUDIO_END_TO_END_RTT	音频端到端延时。
VIDEO_END_TO_END_RTT	视频端到端延时。
AUDIO_BIT_RATE	音频码率。
AUDIO_STUCK	音频卡顿。
AUDIO_LEVEL	音量。
VIDEO_BIT_RATE_CAMERA	摄像头视频码率。
VIDEO_BIT_RATE_LARGE	视频码率（大画面）。
VIDEO_BIT_RATE_SMALL	视频码率（小画面）。
VIDEO_BIT_RATE_SUPER	视频码率（超大屏幕）。
VIDEO_BIT_RATE_SHARE	视频码率（屏幕分享）。
VIDEO_STUCK_CAMERA	摄像头视频卡顿。
VIDEO_STUCK_LARGE	视频卡顿（大画面）。
VIDEO_STUCK_SMALL	视频卡顿（小画面）。
VIDEO_STUCK_SUPER	视频卡顿（超大屏幕）。
VIDEO_STUCK_SHARE	视频卡顿（屏幕分享）。
VIDEO_RESOLUTION_CAMERA	摄像头视频分辨率。
VIDEO_RESOLUTION_LARGE	视频分辨率（大画面）。
VIDEO_RESOLUTION_SMALL	视频分辨率（小画面）。
VIDEO_RESOLUTION_SUPER	视频分辨率（超大屏幕）。
VIDEO_RESOLUTION_SHARE	视频分辨率（屏幕分享）。
VIDEO_FPS_CAMERA	摄像头视频帧率。
VIDEO_FPS_LARGE	视频帧率（大画面）。
VIDEO_FPS_SMALL	视频帧率（小画面）。
VIDEO_FPS_SUPER	视频帧率（超大屏幕）。
VIDEO_FPS_SHARE	视频帧率（屏幕分享）。

返回数据


名称	类型	示例值	描述
SubMetrics	Array of MetricDataItem		订阅端用户指标数据。
Type	String	VIDEO_STUCK_CAMERA	订阅端指标，更多信息，请参见请求参数中指标枚举列表。
UserId	String	testuserid1	用户ID。
Nodes	Array of Node		订阅端指标趋势图坐标点列表。
X	String	1548670257	订阅端指标趋势图中x轴横坐标。
Y	String	230100	订阅端指标趋势图y轴纵坐标。
Ext	Map		拓展属性。
PubMetrics	Array of MetricDataItem		发布端用户指标数据。
Type	String	APP_CPU	发布端指标，更多信息，请参见请求参数中指标枚举列表。
UserId	String	testuserid2	用户ID。
Nodes	Array of Node		发布端指标趋势图坐标点列表。
X	String	1548670257	发布端指标趋势图中x轴横坐标。
Y	String	230100	发布端指标趋势图中y轴纵坐标。
Ext	Map		拓展属性。
RequestId	String	478B9DE1-3958-4734-AE4F-534658AD8574	请求ID。

示例

请求示例

POST api/call/describeEndPointMetricData?AppId=9qb1****&ChannelId=311&CreatedTs=1615887685&DestroyedTs=1615888615&Metrics=APP_CPU,SYSTEM_CPU&PubUserId=c906531af5f9**** HTTP/1.1 
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeEndPointMetricDataResponse>
<code>200</code>
<data>
    <RequestId>478B9DE1-3958-4734-AE4F-534658AD8574</RequestId>
    <PubMetrics>
        <Type>APP_CPU</Type>
    </PubMetrics>
    <PubMetrics>
        <Type>SYSTEM_CPU</Type>
    </PubMetrics>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>478B9DE1-3958-4734-AE4F-534658AD8574</requestId>
<successResponse>true</successResponse>
</DescribeEndPointMetricDataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "RequestId" : "478B9DE1-3958-4734-AE4F-534658AD8574",
    "PubMetrics" : [ {
      "Type" : "APP_CPU",
      "Nodes" : [ ]
    }, {
      "Type" : "SYSTEM_CPU",
      "Nodes" : [ ]
    } ],
    "SubMetrics" : [ ]
  },
  "httpStatusCode" : "200",
  "requestId" : "478B9DE1-3958-4734-AE4F-534658AD8574",
  "successResponse" : true
}