調用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
}