调用DescribeQoeMetricData获取单次通信中用户的下行体验质量指标。

使用说明

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

QPS限制

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

调试

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

请求头

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

请求语法

POST /api/call/describeQoeMetricData 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时间戳表示,单位:秒。参数为空表示获取当前时间。

说明 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
UserId String Query c906531af5f9****

用户ID。

返回数据

名称 类型 示例值 描述
VideoData Array of QoeMetricDataItem

视频数据。

Type String VIDEO_CAMERA

影响通信体验的指标类型,取值:

  • VIDEO_CAMERA:摄像头码率。
  • VIDEO_CAMERA_LARGE:摄像头大流码率。
  • VIDEO_CAMERA_SMALL:摄像头小流码率。
  • VIDEO_CAMERA_SUPER:摄像头超大流码率。
  • VIDEO_SCREEN_SHARE:共享屏幕流码率。
  • VIDEO_STUCK_CAMERA:摄像头卡顿。
  • VIDEO_STUCK_CAMERA_LARGE:摄像头大流卡顿。
  • VIDEO_STUCK_CAMERA_SMALL:摄像头小流卡顿。
  • VIDEO_STUCK_CAMERA_SUPER:摄像头超大流卡顿。
  • VIDEO_STUCK_SCREEN_SHARE:屏幕共享卡顿。
  • VIDEO_VAGUE_CAMERA:摄像头模糊。
  • VIDEO_VAGUE_CAMERA_LARGE:摄像头大流模糊。
  • VIDEO_VAGUE_CAMERA_SMALL:摄像头小流模糊。
  • VIDEO_VAGUE_CAMERA_SUPER:摄像头超大流模糊。
  • VIDEO_VAGUE_SCREEN_SHARE:屏幕共享模糊。
UserId String c906531af5f9****

用户ID。

Nodes Array of Node

视频指标趋势图坐标点列表。

X String 1548670256

视频指标趋势图中x轴横坐标。

Y String 123

视频指标趋势图中y轴纵坐标。

AudioData Array of QoeMetricDataItem

音频数据。

Type String AUDIO

影响通信体验的指标类型,取值:

  • AUDIO:音频码率。
  • AUDIO_STUCK:音频下行卡顿。
UserId String c906531af5f9****

用户ID。

Nodes Array of Node

音频指标趋势图坐标点列表。

X String 1548670256

音频指标趋势图中x轴横坐标。

Y String 123

音频指标趋势图中y轴纵坐标。

RequestId String 963F15CA-9D61-4341-B9D0-123E97229829

请求ID。

示例

请求示例

POST api/call/describeQoeMetricData?AppId=9qb1****&ChannelId=311&CreatedTs=1615887685&DestroyedTs=1615888615&UserId=c906531af5f9**** HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式

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

<DescribeQoeMetricDataResponse>
<code>200</code>
<data>
    <RequestId>963F15CA-9D61-4341-B9D0-123E97229829</RequestId>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>963F15CA-9D61-4341-B9D0-123E97229829</requestId>
<successResponse>true</successResponse>
</DescribeQoeMetricDataResponse>

JSON格式

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

{
  "code" : "200",
  "data" : {
    "AudioData" : [ ],
    "RequestId" : "963F15CA-9D61-4341-B9D0-123E97229829",
    "VideoData" : [ ]
  },
  "httpStatusCode" : "200",
  "requestId" : "963F15CA-9D61-4341-B9D0-123E97229829",
  "successResponse" : true
}