調用DescribeEndPointMetricData獲取端對端指標數據。
使用說明
本接口用于獲取端對端指標數據。例如：您可以獲取訂閱端和發布端的指標信息。
QPS限制
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /api/call/describeEndPointMetricData 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時間戳表示，單位：秒。參數為空表示獲取當前時間。 說明 如果傳入的頻道釋放時間超過真實的釋放時間，將返回從創建時間開始到真實釋放時間之間的數據，且最多返回最近3個小時的數據。
|
| SubUserId | String | Query | 否 | testsubuserid |
訂閱端用戶ID。 |
| PubUserId | String | Query | 否 | c906531af5f9**** |
發布端用戶ID。 說明 PubUserId和PubCallIdList參數只能二選一輸入。
|
| PubCallIdList | String | Query | 否 | testcall1,testcall2 |
發布端用戶通信流的Call ID，多個用英文逗號（,）分隔。 說明 PubUserId和PubCallIdList參數只能二選一輸入。
|
| Metrics | String | Query | 是 | APP_CPU,SYSTEM_CPU |
指標枚舉列表，多個用英文逗號（,）分隔。 |
指標如下所示：
|
名稱 |
說明 |
|---|---|
|
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_END_TO_END_RTT |
音頻端到端延時。 |
|
VIDEO_END_TO_END_RTT |
視頻端到端延時。 |
|
AUDIO_BIT_RATE |
音頻碼率。 |
|
AUDIO_STUCK |
音頻卡頓。 |
|
AUDIO_LEVEL |
音量。 |
|
VIDEO_BIT_RATE_CAMERA |
攝像頭視頻碼率。 |
|
VIDEO_BIT_RATE_LARGE |
視頻碼率（大畫面）。 |
|
VIDEO_BIT_RATE_SMALL |
視頻碼率（小畫面）。 |
|
VIDEO_BIT_RATE_SUPER |
視頻碼率（超大屏幕）。 |
|
VIDEO_BIT_RATE_SHARE |
視頻碼率（屏幕分享）。 |
|
VIDEO_STUCK_CAMERA |
攝像頭視頻卡頓。 |
|
VIDEO_STUCK_LARGE |
視頻卡頓（大畫面）。 |
|
VIDEO_STUCK_SMALL |
視頻卡頓（小畫面）。 |
|
VIDEO_STUCK_SUPER |
視頻卡頓（超大屏幕）。 |
|
VIDEO_STUCK_SHARE |
視頻卡頓（屏幕分享）。 |
|
VIDEO_RESOLUTION_CAMERA |
攝像頭視頻分辨率。 |
|
VIDEO_RESOLUTION_LARGE |
視頻分辨率（大畫面）。 |
|
VIDEO_RESOLUTION_SMALL |
視頻分辨率（小畫面）。 |
|
VIDEO_RESOLUTION_SUPER |
視頻分辨率（超大屏幕）。 |
|
VIDEO_RESOLUTION_SHARE |
視頻分辨率（屏幕分享）。 |
|
VIDEO_FPS_CAMERA |
攝像頭視頻幀率。 |
|
VIDEO_FPS_LARGE |
視頻幀率（大畫面）。 |
|
VIDEO_FPS_SMALL |
視頻幀率（小畫面）。 |
|
VIDEO_FPS_SUPER |
視頻幀率（超大屏幕）。 |
|
VIDEO_FPS_SHARE |
視頻幀率（屏幕分享）。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| SubMetrics | Array of MetricDataItem |
訂閱端用戶指標數據。 |
|
| Type | String | VIDEO_STUCK_CAMERA |
訂閱端指標，更多信息，請參見請求參數中指標枚舉列表。 |
| UserId | String | testuserid1 |
用戶ID。 |
| Nodes | Array of Node |
訂閱端指標趨勢圖坐標點列表。 |
|
| X | String | 1548670257 |
訂閱端指標趨勢圖中x軸橫坐標。 |
| Y | String | 230100 |
訂閱端指標趨勢圖y軸縱坐標。 |
| Ext | Map |
拓展屬性。 |
|
| PubMetrics | Array of MetricDataItem |
發布端用戶指標數據。 |
|
| Type | String | APP_CPU |
發布端指標，更多信息，請參見請求參數中指標枚舉列表。 |
| UserId | String | testuserid2 |
用戶ID。 |
| Nodes | Array of Node |
發布端指標趨勢圖坐標點列表。 |
|
| X | String | 1548670257 |
發布端指標趨勢圖中x軸橫坐標。 |
| Y | String | 230100 |
發布端指標趨勢圖中y軸縱坐標。 |
| Ext | Map |
拓展屬性。 |
|
| RequestId | String | 478B9DE1-3958-4734-AE4F-534658AD8574 |
請求ID。 |
示例
請求示例
POST api/call/describeEndPointMetricData?AppId=9qb1****&ChannelId=311&CreatedTs=1615887685&DestroyedTs=1615888615&Metrics=APP_CPU,SYSTEM_CPU&PubUserId=c906531af5f9**** HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com
Date: GMT Date正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeEndPointMetricDataResponse>
<code>200</code>
<data>
<RequestId>478B9DE1-3958-4734-AE4F-534658AD8574</RequestId>
<PubMetrics>
<Type>APP_CPU</Type>
</PubMetrics>
<PubMetrics>
<Type>SYSTEM_CPU</Type>
</PubMetrics>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>478B9DE1-3958-4734-AE4F-534658AD8574</requestId>
<successResponse>true</successResponse>
</DescribeEndPointMetricDataResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200",
"data" : {
"RequestId" : "478B9DE1-3958-4734-AE4F-534658AD8574",
"PubMetrics" : [ {
"Type" : "APP_CPU",
"Nodes" : [ ]
}, {
"Type" : "SYSTEM_CPU",
"Nodes" : [ ]
} ],
"SubMetrics" : [ ]
},
"httpStatusCode" : "200",
"requestId" : "478B9DE1-3958-4734-AE4F-534658AD8574",
"successResponse" : true
}