調用DescribeFaultDiagnosisUserDetail獲取異常診斷的用戶詳情。

使用說明

本接口用于獲取異常診斷的概覽數據。使用該接口時,支持查詢最近48小時的數據。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業(yè)務,請合理調用。更多信息,請參見QPS限制

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /api/diagnosis/describeFaultDiagnosisUserDetail HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
AppId String Query 0rbd****

App ID,可通過控制臺創(chuàng)建和查詢。

ChannelId String Query 311

頻道ID。

CreatedTs Long Query 1615892596

創(chuàng)建頻道的時間,使用UNIX時間戳表示,單位:秒。

UserId String Query 0a497933****

用戶ID。

FaultType String Query JOIN_SLOW

過濾的異常類型,取值:

  • JOIN_SLOW:進頻道慢。
  • AUDIO_STUCK:音頻卡頓。
  • VIDEO_STUCK:視頻卡頓。
  • VIDEO_VAGUE:視頻模糊。
  • HIGH_DELAY:通話延遲高。
  • FIRST_FRAME_SLOW:接收首屏慢。

關于異常類型詳情,請參見異常類型說明

QueryCallUserInfo Boolean Query true

是否查詢通話用戶信息,參數為空表示false。

返回數據

名稱 類型 示例值 描述
CallInfo Object

通信基本信息(當QueryCallUserInfo為true時返回)。

AppId String 0rbd****

App ID。

ChannelId String 311

頻道ID。

CallStatus String IN

通信狀態(tài)。取值:

  • IN:進行中。
  • OUT:已結束。
CreatedTs Long 1620957905

創(chuàng)建通信時間,使用UNIX時間戳表示,單位:秒。

DestroyedTs Long 1620958150

釋放通信時間,使用UNIX時間戳表示,單位:秒。

Duration Long 245

通信持續(xù)時長,單位:秒。

UserDetail Object

診斷用戶詳細信(當QueryCallUserInfo為true時返回)。

UserId String 0a497933****

用戶ID。

Location String 浙江省-杭州市

地理位置信息。

OnlinePeriods Array of OnlinePeriod

在線時段信息。

JoinTs Long 1620957919

加入通話時間,使用UNIX時間戳表示,單位:秒。

LeaveTs Long 1620958150

離開通話時間,使用UNIX時間戳表示,單位:秒。

CreatedTs Long 1620957919

創(chuàng)建通話時間,使用UNIX時間戳表示,單位:秒。

DestroyedTs Long 1620958150

釋放通話時間,使用UNIX時間戳表示,單位:秒。通話未結束時值為0。

OnlineDuration Long 231

在線時長,單位:秒。

Duration Long 231

通話時長,首次進入到最后離開,單位:秒。

SdkVersion String 2.2.2105081533277

SDK版本。

Os String iOS

瀏覽器或操作系統(tǒng)類型,例如Chrome、iOS、Android等。

說明 如果客戶端為Web,返回瀏覽器類型;如果客戶端為本地Native端,返回操作系統(tǒng)類型。
Network String WiFi

網絡類型,例如WiFi、4G等

FaultMetricData Object

異常指標。

Nodes Array of Node

指標趨勢圖坐標點列表。

X String 1620957900

指標趨勢圖中x軸橫坐標,單位時間為1分鐘。

Y String 0.4540

指標趨勢圖中y軸縱坐標。

FactorList Array of FactorData

影響因素列表,參數為空表示影響因素未知。

FactorId String 2

影響因素ID,詳情請參見下文中的影響因素ID取值。

FaultSource String LOCAL

異常來源 LOCAL:本端 REMOTE:遠端

RelatedMetricDatas Array of MetricData

關聯的指標,當FaultType為AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY時返回坐標數據。

Role String RECEIVER

來源角色,取值:

  • SENDER:發(fā)布端。
  • RECEIVER:訂閱端。
UserId String 0a497933****

用戶ID。

Type String AUDIO_STUCK

指標類型。

Nodes Array of Node

指標趨勢圖坐標點列表。

X String 1620957937

指標趨勢圖中x軸橫坐標。

Y String 529.39

指標趨勢圖中y軸縱坐標。

Ext Map

擴展數據。

RelatedEventDatas Array of EventData

關聯的事件,按時間分組,當FaultType為AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY時返回坐標數據。

UserId String 0a497933****

用戶ID。

Role String SENDER

來源角色,取值:

  • SENDER:發(fā)布端。
  • RECEIVER:訂閱端。
EventDataItems Array of EventDataItems、

事件數據列表。

Ts Long 1614936817

第一個事件發(fā)生的時間,使用UNIX時間戳表示,單位:秒。

EventList Array of EventList

事件列表。

EventName String 開始發(fā)布

事件名稱。

EventType String USER

事件類型,取值:

  • USER:用戶事件。
  • SYSTEM:系統(tǒng)事件。
Ts Long 1614936817

事件發(fā)生的時間,使用UNIX時間戳表示,單位:秒。

NetworkOperators Array of String 移動

網絡運營商。

RequestId String 1DB846A6-969D-4873-B592-B4A8D1CA3294

請求ID。

影響因素ID取值如下所示:

ID

描述

1

發(fā)布端網絡差。

2

訂閱端網絡差。

3

發(fā)布端設備性能差。

4

發(fā)布端關閉攝像頭。

5

發(fā)布端切到后臺運行。

6

發(fā)布端WiFi信號差。

7

訂閱端WiFi信號差。

8

發(fā)布端CPU使用率高。

9

訂閱端CPU使用率高。

10

DNS解析慢。

11

獲取配置解析慢。

12

GSLB解析慢。

13

發(fā)布端網絡延遲抖動。

14

發(fā)布端網丟包抖動。

15

發(fā)布端帶寬低。

16

訂閱端網絡延遲抖動。

17

訂閱端網絡丟包抖動。

18

訂閱端帶寬低。

UNKNOWN

未知。

示例

請求示例

POST /api/diagnosis/describeFaultDiagnosisUserDetail?AppId=0rbd****&ChannelId=311&CreatedTs=1615892596&UserId=0a497933****&FaultType=JOIN_SLOW&QueryCallUserInfo=true HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式

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

<DescribeFaultDiagnosisUserDetailResponse>
    <code>200</code>
    <data>
        <UserDetail>
            <DestroyedTs>1620958150</DestroyedTs>
            <Os>iOS</Os>
            <UserId>0a497933****</UserId>
            <Network>WiFi</Network>
            <SdkVersion>2.2.2105081533277</SdkVersion>
            <Duration>231</Duration>
            <CreatedTs>1620957919</CreatedTs>
            <OnlineDuration>231</OnlineDuration>
            <OnlinePeriods>
                <LeaveTs>1620958150</LeaveTs>
                <JoinTs>1620957919</JoinTs>
            </OnlinePeriods>
            <Location>浙江省-杭州市</Location>
        </UserDetail>
        <FactorList>
            <RelatedMetricDatas>
                <Role>RECEIVER</Role>
                <Type>AUDIO_STUCK</Type>
                <UserId>0a497933****</UserId>
                <Nodes>
                    <X>1620957937</X>
                    <Y>529.39</Y>
                </Nodes>
                <Nodes>
                    <X>1620957953</X>
                    <Y>359.99</Y>
                </Nodes>
            </RelatedMetricDatas>
            <RelatedMetricDatas>
                <Role>RECEIVER</Role>
                <Type>AUDIO_RTT</Type>
                <UserId>0a497933****</UserId>
                <Nodes>
                    <X>1620957937</X>
                    <Y>323.5</Y>
                </Nodes>
                <Nodes>
                    <X>1620957939</X>
                    <Y>1002</Y>
                </Nodes>
            </RelatedMetricDatas>
            <FactorId>2</FactorId>
        </FactorList>
        <RequestId>1DB846A6-969D-4873-B592-B4A8D1CA3294</RequestId>
        <CallInfo>
            <DestroyedTs>1620958150</DestroyedTs>
            <AppId>0rbd****</AppId>
            <CallStatus>OUT</CallStatus>
            <Duration>245</Duration>
            <CreatedTs>1620957905</CreatedTs>
            <ChannelId>311</ChannelId>
        </CallInfo>
        <FaultMetricData>
            <Nodes>
                <X>1620957900</X>
                <Y>0.4540</Y>
            </Nodes>
            <Nodes>
                <X>1620957960</X>
                <Y>0.5175</Y>
            </Nodes>
            <Nodes>
                <X>1620958020</X>
                <Y>0.4775</Y>
            </Nodes>
            <Nodes>
                <X>1620958080</X>
                <Y>0.3375</Y>
            </Nodes>
        </FaultMetricData>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>1DB846A6-969D-4873-B592-B4A8D1CA3294</requestId>
    <successResponse>true</successResponse>
</DescribeFaultDiagnosisUserDetailResponse>

JSON格式

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

{
  "code" : "200",
  "data" : {
    "UserDetail" : {
      "DestroyedTs" : 1620958150,
      "Os" : "iOS",
      "UserId" : "0a497933****",
      "Network" : "WiFi",
      "SdkVersion" : "2.2.2105081533277",
      "Duration" : 231,
      "CreatedTs" : 1620957919,
      "OnlineDuration" : 231,
      "OnlinePeriods" : [ {
        "LeaveTs" : 1620958150,
        "JoinTs" : 1620957919
      } ],
      "Location" : "浙江省-杭州市"
    },
    "FactorList" : [ {
      "RelatedMetricDatas" : [ {
        "Role" : "RECEIVER",
        "Type" : "AUDIO_STUCK",
        "UserId" : "0a497933****",
        "Nodes" : [ {
          "X" : "1620957937",
          "Y" : "529.39"
        }, {
          "X" : "1620957953",
          "Y" : "359.99"
        } ]
      }, {
        "Role" : "RECEIVER",
        "Type" : "AUDIO_RTT",
        "UserId" : "0a497933****",
        "Nodes" : [ {
          "X" : "1620957937",
          "Y" : "323.5"
        }, {
          "X" : "1620957939",
          "Y" : "1002"
        } ]
      } ],
      "FactorId" : "2"
    } ],
    "RequestId" : "1DB846A6-969D-4873-B592-B4A8D1CA3294",
    "CallInfo" : {
      "DestroyedTs" : 1620958150,
      "AppId" : "0rbd****",
      "CallStatus" : "OUT",
      "Duration" : 245,
      "CreatedTs" : 1620957905,
      "ChannelId" : "311"
    },
    "FaultMetricData" : {
      "Nodes" : [ {
        "X" : "1620957900",
        "Y" : "0.4540"
      }, {
        "X" : "1620957960",
        "Y" : "0.5175"
      }, {
        "X" : "1620958020",
        "Y" : "0.4775"
      }, {
        "X" : "1620958080",
        "Y" : "0.3375"
      } ]
    }
  },
  "httpStatusCode" : "200",
  "requestId" : "1DB846A6-969D-4873-B592-B4A8D1CA3294",
  "successResponse" : true
}