調(diào)用DescribeChannelOverallData查詢頻道概覽數(shù)據(jù)。
使用說明
本接口用于查詢頻道概覽數(shù)據(jù)。例如：您可以查詢通信基本信息、指標趨勢圖等信息。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制，API調(diào)用會被限流，這可能會影響您的業(yè)務(wù)，請合理調(diào)用。更多信息，請參見QPS限制。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。
請求語法
POST /api/channel/describeChannelOverallData HTTP/1.1請求參數(shù)
| 名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|---|
| AppId | String | Query | 是 | 9qb1**** |
App ID，可通過控制臺創(chuàng)建和查詢。 |
| ChannelId | String | Query | 是 | 123333 |
頻道ID。 |
| CreatedTs | Long | Query | 是 | 1615893133 |
創(chuàng)建頻道的時間戳，支持查詢最近30天的數(shù)據(jù)。使用UNIX時間戳表示，單位：秒。 |
| DestroyedTs | Long | Query | 否 | 1615893757 |
釋放頻道的時間戳，使用UNIX時間戳表示，單位：秒。參數(shù)為空表示獲取當前時間。 說明 如果傳入的頻道釋放時間超過真實的釋放時間，將返回從創(chuàng)建時間開始到真實釋放時間之間的數(shù)據(jù)。
|
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| MetricDatas | Array of MetricDatas |
指標數(shù)據(jù)列表。 |
|
| Type | String | CALL_QUALITY |
指標類型，取值：
|
| Nodes | Array of Nodes |
指標趨勢圖坐標點列表。 |
|
| X | String | 1612418625 |
指標趨勢圖中x軸橫坐標。當Type=CALL_QUALITY時，x軸橫坐標表示時間戳，當Type=CONN_NUM時，x軸橫坐標取值：
|
| Y | String | 123 |
指標趨勢圖中y軸縱坐標。 |
| Ext | Map |
擴展數(shù)據(jù)。 |
|
| OverallData | Object |
概覽數(shù)據(jù)。 |
|
| ConnAvgTime | Float | 0.10325 |
平均通信連接的用時，單位：秒。 |
| FiveSecJoinRate | Float | 1.0 |
5秒內(nèi)連通成功率，用小數(shù)表示，例如1.0表示連通成功率為100%。 |
| TotalAudioStuckRate | Float | 0.02 |
整體音頻卡頓率，用小數(shù)表示，例如0.02表示音頻卡頓率為2%。 |
| TotalVideoStuckRate | Float | 0.02 |
整體視頻卡頓率，用小數(shù)表示，例如0.02表示視頻卡頓率為2%。 |
| TotalVideoVagueRate | Float | 0.02 |
整體視頻模糊率，用小數(shù)表示，例如0.02表示視頻模糊率為2%。 |
| CallInfo | Object |
通信基本信息。 |
|
| AppId | String | 9qb1**** |
應(yīng)用ID。 |
| ChannelId | String | 123456 |
頻道ID。 |
| CallStatus | String | IN |
通信狀態(tài)，取值：
|
| CreatedTs | Long | 1615860711 |
創(chuàng)建通信的時間戳，使用UNIX時間戳表示，單位：秒。 |
| DestroyedTs | Long | 1615860811 |
釋放通信的時間戳，使用UNIX時間戳表示，單位：秒。 |
| Duration | Long | 100 |
通信時長，單位：秒。 |
| RequestId | String | C9F1EB03-1B7E-4115-ABFA-CB945B2348E7 |
請求ID。 |
示例
請求示例
POST api/channel/describeChannelOverallData?AppId=9qb1****&ChannelId=123333&CreatedTs=1615893133&DestroyedTs=1615893757 HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com
Date: GMT Date正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeChannelOverallDataResponse>
<code>200</code>
<data>
<RequestId>C9F1EB03-1B7E-4115-ABFA-CB945B2348E7</RequestId>
<OverallData>
<ConnAvgTime>0.10325</ConnAvgTime>
<FiveSecJoinRate>1</FiveSecJoinRate>
</OverallData>
<MetricDatas>
<Type>CONN_NUM</Type>
<Nodes>
<Ext>
<num>4</num>
</Ext>
<X>WITHIN_FIVE</X>
<Y>1.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>FIVE_TO_TEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>TEN_TO_FIFTEEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>ABOVE_FIFTEEN</X>
<Y>0.0000</Y>
</Nodes>
<Nodes>
<Ext>
<num>0</num>
</Ext>
<X>CONN_FAIL</X>
<Y>0.0000</Y>
</Nodes>
</MetricDatas>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>C9F1EB03-1B7E-4115-ABFA-CB945B2348E7</requestId>
<successResponse>true</successResponse>
</DescribeChannelOverallDataResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200",
"data" : {
"RequestId" : "C9F1EB03-1B7E-4115-ABFA-CB945B2348E7",
"OverallData" : {
"ConnAvgTime" : 0.10325,
"FiveSecJoinRate" : 1.0
},
"MetricDatas" : [ {
"Type" : "CONN_NUM",
"Nodes" : [ {
"Ext" : {
"num" : 4
},
"X" : "WITHIN_FIVE",
"Y" : "1.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "FIVE_TO_TEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "TEN_TO_FIFTEEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "ABOVE_FIFTEEN",
"Y" : "0.0000"
}, {
"Ext" : {
"num" : 0
},
"X" : "CONN_FAIL",
"Y" : "0.0000"
} ]
} ]
},
"httpStatusCode" : "200",
"requestId" : "C9F1EB03-1B7E-4115-ABFA-CB945B2348E7",
"successResponse" : true
}