文档

DescribeFaultDiagnosisOverallData - 获取异常诊断的概览数据

更新时间:

调用DescribeFaultDiagnosisOverallData获取异常诊断的概览数据。

接口说明

使用说明

本接口用于获取异常诊断的概览数据。使用该接口时,支持查询最近 48 小时且查询范围不超过 24 小时的数据。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

4eah****
StartTslong

查询的开始时间,使用 UNIX 时间戳表示,单位:秒。

1615824000
EndTslong

查询的结束时间,使用 UNIX 时间戳表示,单位:秒。

1615910399
StatDimstring

获取数据统计维度。取值:

  • JOIN_SLOW_USER:进频道慢用户数。
  • AUDIO_STUCK_USER:音频卡顿用户数。
  • VIDEO_STUCK_USER:视频卡顿用户数。
  • VIDEO_VAGUE_USER:视频模糊用户数。
  • HIGH_DELAY_USER:通话延迟高用户数。
  • FIRST_SCREEN_SLOW_USER:接收首屏慢用户数。
JOIN_SLOW_USER

返回参数

名称类型描述示例值
object

返回结果。

OverallDataobject

异常诊断的概览数据列表。

FaultUserCountinteger

异常人次或异常用户数。

20
TotalUserCountinteger

总人次或总用户数。

40
FaultUserRatiofloat

异常用户总占比。

0.5
MetricDataobject

异常指标数据。

Nodesobject []

指标趋势图坐标点列表。

Xstring

指标趋势图中 x 轴横坐标,单位时间为 1 分钟。

1615824000
Ystring

指标趋势图中 y 轴纵坐标。

1
Extobject

拓展属性,ratio:单位时间内异常用户占比,totalCount:单位时间内用户总数

RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "OverallData": {
    "FaultUserCount": 20,
    "TotalUserCount": 40,
    "FaultUserRatio": 0.5
  },
  "MetricData": {
    "Nodes": [
      {
        "X": "1615824000",
        "Y": "1",
        "Ext": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  },
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。