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

本接口用于获取端对端指标数据。

接口说明

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	APP ID。	testappid
ChannelId	string	是	频道 ID	testid
CreatedTs	long	是	查询时间区间的开始时间，该时间不得早于频道实际的创建时间，不得早于 30 天之前。使用 UNIX 时间戳表示，单位：秒。	1614936817
DestroyedTs	long	否	查询时间区间的结束时间，该时间不得晚于频道释放时间。使用 UNIX 时间戳表示，单位：秒。参数为空，表示获取当前时间。说明如果传入的结束时间超过频道的释放时间，将返回从开始时间开始到频道释放时间之间的数据，且最多返回最近 3 个小时的数据。	1614936817
SubUserId	string	否	订阅端用户 ID。	testuserid
PubUserId	string	否	发布端用户 ID。说明 PubUserId 和 PubCallIdList 参数只能二选一输入。	testuserid2
PubCallIdList	string	否	发布端用户通信流的 Call ID，多个用英文逗号（,）分隔。说明 PubUserId 和 PubCallIdList 参数只能二选一输入。	testcall1,testcall2
Metrics	string	是	指标枚举列表，多个用英文逗号（,）分隔。	VIDEO_STUCK_CAMERA

指标如下所示：

名称	说明
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_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	视频帧率（屏幕分享）。

返回参数

名称	类型	描述	示例值
	object
SubMetrics	object []	订阅端用户指标数据。
Type	string	对应入参 Metrics 中的类型。	VIDEO_STUCK_CAMERA
UserId	string	用户 ID。	testuserid
Nodes	object []	订阅端指标趋势图坐标点列表。
X	string	订阅端指标趋势图中 x 轴横坐标。	1548670257
Y	string	订阅端指标趋势图 y 轴纵坐标。	230100
Ext	object	拓展属性。
PubMetrics	object []	发布端用户指标数据。
Type	string	对应入参 Metrics 中的类型。	VIDEO_STUCK_CAMERA
UserId	string	用户 ID。	testuserid
Nodes	object []	坐标点列表。
X	string	发布端指标趋势图中 x 轴横坐标。	1548670257
Y	string	发布端指标趋势图中 y 轴纵坐标。	230100
Ext	object	拓展属性。
RequestId	string	请求 ID。	231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "SubMetrics": [
    {
      "Type": "VIDEO_STUCK_CAMERA",
      "UserId": "testuserid",
      "Nodes": [
        {
          "X": "1548670257",
          "Y": "230100",
          "Ext": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    }
  ],
  "PubMetrics": [
    {
      "Type": "VIDEO_STUCK_CAMERA",
      "UserId": "testuserid",
      "Nodes": [
        {
          "X": "1548670257",
          "Y": "230100",
          "Ext": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ApiParamError	API %s.	Api参数错误
403	BizAppError	A business application permission error occurred.	业务应用权限错误
403	BizUidError	A business UID error occurred.	业务主账号错误
500	ServerInternalError	An internal error occurred.	服务器内部错误

访问错误中心查看更多错误码。