調用DescribeFaultDiagnosisOverallData獲取異常診斷的概覽數據。

使用說明

本接口用于獲取異常診斷的概覽數據。使用該接口時，支持查詢最近48小時且查詢范圍不超過24小時的數據。

QPS限制

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

調試

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

請求頭

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

請求語法

POST /api/diagnosis/describeFaultDiagnosisOverallData HTTP/1.1

請求參數

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

App ID，可通過控制臺創建和查詢。
StartTs Long Query 是 1615824000

查詢的開始時間，使用UNIX時間戳表示，單位：秒。
EndTs Long Query 是 1615910399

查詢的結束時間，使用UNIX時間戳表示，單位：秒。
StatDim String Query 是 JOIN_SLOW_USER

統計維度，取值：

  • JOIN_SLOW_USER：進頻道慢人次。
  • AUDIO_STUCK_USER：音頻卡頓用戶數。
  • VIDEO_STUCK_USER：視頻卡頓用戶數。
  • VIDEO_VAGUE_USER：視頻模糊用戶數。
  • HIGH_DELAY_USER：通話延遲高用戶數。
  • FIRST_FRAME_SLOW_USER：接收首屏慢人次。

關于統計維度詳情，請參見異常類型說明。

返回數據

名稱 類型 示例值 描述
OverallData Object

異常診斷的概覽數據列表。
FaultUserCount Integer 3

異常人次或異常用戶數。
TotalUserCount Integer 1027

總人次或總用戶數。
FaultUserRatio Float 0.0029

異常用戶總占比。
MetricData Object

異常指標數據。
Nodes Array of Node

指標趨勢圖坐標點列表。
X String 1620725400

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

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

拓展屬性。其中，ratio表示單位時間內異常用戶占比；totalCount表示單位時間內用戶總數。
RequestId String 1C24B3B5-E41A-45CE-844D-D3C578B97AA6

請求ID。

示例

請求示例

POST /api/diagnosis/describeFaultDiagnosisOverallData?AppId=0rbd****&StartTs=1615824000&EndTs=1615910399&StatDim=JOIN_SLOW_USER HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

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

<DescribeFaultDiagnosisOverallDataResponse>
    <code>200</code>
    <data>
        <RequestId>1C24B3B5-E41A-45CE-844D-D3C578B97AA6</RequestId>
        <OverallData>
            <FaultUserCount>3</FaultUserCount>
            <FaultUserRatio>0.0029</FaultUserRatio>
            <TotalUserCount>1027</TotalUserCount>
        </OverallData>
        <MetricData>
            <Nodes>
                <Ext>
                    <totalCount>2</totalCount>
                    <ratio>0.5</ratio>
                </Ext>
                <X>1620725400</X>
                <Y>1</Y>
            </Nodes>
            <Nodes>
                <Ext>
                    <totalCount>1</totalCount>
                    <ratio>1</ratio>
                </Ext>
                <X>1620738780</X>
                <Y>1</Y>
            </Nodes>
            <Nodes>
                <Ext>
                    <totalCount>1</totalCount>
                    <ratio>1</ratio>
                </Ext>
                <X>1620739140</X>
                <Y>1</Y>
            </Nodes>
        </MetricData>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>1C24B3B5-E41A-45CE-844D-D3C578B97AA6</requestId>
    <successResponse>true</successResponse>
</DescribeFaultDiagnosisOverallDataResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "1C24B3B5-E41A-45CE-844D-D3C578B97AA6",
    "OverallData" : {
      "FaultUserCount" : 3,
      "FaultUserRatio" : 0.0029,
      "TotalUserCount" : 1027
    },
    "MetricData" : {
      "Nodes" : [ {
        "Ext" : {
          "totalCount" : 2,
          "ratio" : "0.5"
        },
        "X" : "1620725400",
        "Y" : "1"
      }, {
        "Ext" : {
          "totalCount" : 1,
          "ratio" : "1"
        },
        "X" : "1620738780",
        "Y" : "1"
      }, {
        "Ext" : {
          "totalCount" : 1,
          "ratio" : "1"
        },
        "X" : "1620739140",
        "Y" : "1"
      } ]
    }
  },
  "httpStatusCode" : "200",
  "requestId" : "1C24B3B5-E41A-45CE-844D-D3C578B97AA6",
  "successResponse" : true
}