DescribeQoeMetricData - 单次通信中下行体验质量指标_音视频通信(RTC)-阿里云帮助中心

本接口用于获取单次通信中用户的下行体验质量指标。

接口说明

使用说明

本接口用于获取单次通信中用户的下行体验质量指标。例如：您可以获取影响通信体验的指标类型、音视频指标趋势图等信息。

QPS 限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	APP ID。	testappid
ChannelId	string	是	频道 ID。	testid
CreatedTs	long	是	创建频道时间，支持查询最近 30 天的数据。使用 UNIX 时间戳表示，单位：秒	1614936817
DestroyedTs	long	否	频道释放时间，使用 UNIX 时间戳表示，单位：秒。参数为空表示获取当前时间。说明如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。	1614936817
UserId	string	是	用户 ID。	testuserid

返回参数

名称	类型	描述	示例值
	object
VideoData	object []	视频数据。
Type	string	影响通信体验的指标类型。取值： VIDEO_CAMERA：摄像头码率。 VIDEO_SCREEN_SHARE：共享屏幕流码率。 VIDEO_STUCK_CAMERA：摄像头卡顿。 VIDEO_STUCK_SCREEN_SHARE：屏幕共享卡顿。 VIDEO_VAGUE_CAMERA：摄像头模糊。 VIDEO_VAGUE_SCREEN_SHARE：屏幕共享模糊。	VIDEO_CAMERA
UserId	string	用户 ID	testuserid2
Nodes	object []	视频指标趋势图坐标点列表。
X	string	视频指标趋势图中 x 轴横坐标。	1548670256
Y	string	视频指标趋势图中 y 轴纵坐标。	123
AudioData	object []	音频数据。
Type	string	通信体验。取值： AUDIO：音频码率。 AUDIO_STUCK：音频下行卡顿。	AUDIO
UserId	string	用户 ID。	testuserid2
Nodes	object []	音频指标趋势图坐标点列表。
X	string	音频指标趋势图中 x 轴横坐标。	1548670256
Y	string	音频指标趋势图中 y 轴纵坐标。	123
RequestId	string	请求 ID。	231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "VideoData": [
    {
      "Type": "VIDEO_CAMERA",
      "UserId": "testuserid2",
      "Nodes": [
        {
          "X": "1548670256",
          "Y": "123"
        }
      ]
    }
  ],
  "AudioData": [
    {
      "Type": "AUDIO",
      "UserId": "testuserid2",
      "Nodes": [
        {
          "X": "1548670256",
          "Y": "123"
        }
      ]
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ApiParamError	API %s.	Api参数错误
403	BizCreatedTsError	A business CreatedTs error occurred.	参数会议创建时间不准确。
403	BizAppError	A business application permission error occurred.	业务应用权限错误
403	BizUidError	A business UID error occurred.	业务主账号错误
500	ServerInternalError	An internal error occurred.	服务器内部错误

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