AI 助理
备案控制台
文档
输入文档关键字查找
首页 音视频通信 开发参考 API参考 API目录 数据服务 异常诊断 DescribeFaultDiagnosisUserDetail - 获取异常诊断的用户详情

DescribeFaultDiagnosisUserDetail - 获取异常诊断的用户详情

更新时间：
产品详情
相关技术圈
我的收藏

调用DescribeFaultDiagnosisUserDetail获取异常诊断的用户详情。

接口说明

使用说明

本接口用于获取异常诊断的概览数据。使用该接口时，支持查询最近 48 小时的数据。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeFaultDiagnosisUserDetail
  • 全部资源
    *
    无
无

请求参数

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

APP ID。

0rbd****
ChannelIdstring是

频道 ID

311
CreatedTslong是

频道创建时间，使用 UNIX 时间戳表示，单位：秒。

1615892596
UserIdstring是

用户 ID

c906531af5f9****
FaultTypestring是

异常类型。取值：

  • JOIN_SLOW：进频道慢 。
  • AUDIO_STUCK：音频卡顿。
  • VIDEO_STUCK：视频卡顿。
  • VIDEO_VAGUE：视频模糊。
  • HIGH_DELAY：通话延迟高 。
  • FIRST_FRAME_SLOW：接收首屏慢。
JOIN_SLOW
QueryCallUserInfoboolean否

是否查询通话用户信息，为空默认是 false。

true

返回参数

名称类型描述示例值
object
CallInfoobject

通信基本信息，QueryCallUserInfo=false 时返回。

AppIdstring

App ID。

testappid
ChannelIdstring

频道 ID。

311
CallStatusstring

通信状态。取值：

  • IN：进行中。
  • OUT：已结束。
IN
CreatedTslong

创建通信时间，使用 UNIX 时间戳表示，单位：秒。

1620957905
DestroyedTslong

释放通信时间，使用 UNIX 时间戳表示，单位：秒。

1620958150
Durationlong

通信持续时长，单位：秒。

100
UserDetailobject

诊断用户详细信，QueryCallUserInfo=false 时返回。

UserIdstring

用户 ID。

testuserid
Locationstring

地理位置信息，例如：北京市-北京市。

浙江省-杭州市
OnlinePeriodsarray<object>

在线时段信息。

OnlinePeriodobject
JoinTslong

加入通话时间，使用 UNIX 时间戳表示，单位：秒。

1620957919
LeaveTslong

离开通话时间，使用 UNIX 时间戳表示，单位：秒。

1620958150
CreatedTslong

创建通话时间，使用 UNIX 时间戳表示，单位：秒。

1620957919
DestroyedTslong

释放通话时间，使用 UNIX 时间戳表示，单位：秒。

1620958150
OnlineDurationlong

在线时长，单位：秒。

231
Durationlong

通话时长，首次进入到最后离开，单位：秒。

231
SdkVersionstring

SDK 版本，如 1.0.0、1.1.1 等。

1.0.0
Osstring

平台类型：若用户客户端为 WEB 则是浏览器类型，若客户端为 NATIVE 则是操作系统类型。

iOS
Networkstring

网络类型，如 WiFi，4G 等。

4G
FaultMetricDataobject

异常指标。

Nodesarray<object>

指标坐标点列表。

Nodeobject
Xstring

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

1620957900
Ystring

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

0.4540
FactorListarray<object>

影响因素列表，空表示影响因素未知。

FactorDataobject
FactorIdstring

影响因素 ID，详情请参见下文中的影响因素 ID 取值。

1
FaultSourcestring

异常来源 LOCAL：本端 REMOTE：远端。

LOCAL
RelatedMetricDatasarray<object>

关联的指标，坐标数据，当 FaultType 为 AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY 时返回。

MetricDataobject
Rolestring

来源角色。取值：

  • SENDER：发布端。
  • RECEIVER：订阅端。
SENDER
UserIdstring

数据来自对应发布端的用户 ID。

testuserid2
Typestring

指标类型，参照端到端指标接口的指标类型。

AUDIO_STUCK
Nodesarray<object>

指标趋势图坐标点列表。

Nodeobject

指标趋势图坐标点详情。

Xstring

指标趋势图中 x 轴横坐标。

1615892596
Ystring

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

20
Extobject

扩展数据。

RelatedEventDatasarray<object>

关联的事件，按时间分组，当 FaultType 为 AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY 时返回坐标数据。

EventDataobject

关联的事件详情。

UserIdstring

用户 ID

0a497933****
Rolestring

来源角色。取值：

  • SENDER：发布端。
  • RECEIVER：订阅端。
SENDER
EventDataItemsarray<object>

事件数据列表。

EventDataItems、object
Tslong

第一个事件发生的时间，使用 UNIX 时间戳表示，单位：秒。

1614936817
EventListarray<object>

事件列表。

EventListobject
EventNamestring

事件名称。

开始发布
EventTypestring

事件类型。取值：

  • USER：用户事件。
  • SYSTEM：系统事件。
USER
Tslong

事件发生的时间，使用 UNIX 时间戳表示，单位：秒。

1614936817
NetworkOperatorsarray

网络运营商列表

NetworkOperatorstring

网络运营商。

移动
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "CallInfo": {
    "AppId": "testappid",
    "ChannelId": "311",
    "CallStatus": "IN",
    "CreatedTs": 1620957905,
    "DestroyedTs": 1620958150,
    "Duration": 100
  },
  "UserDetail": {
    "UserId": "testuserid",
    "Location": "浙江省-杭州市",
    "OnlinePeriods": [
      {
        "JoinTs": 1620957919,
        "LeaveTs": 1620958150
      }
    ],
    "CreatedTs": 1620957919,
    "DestroyedTs": 1620958150,
    "OnlineDuration": 231,
    "Duration": 231,
    "SdkVersion": "1.0.0",
    "Os": "iOS",
    "Network": "4G"
  },
  "FaultMetricData": {
    "Nodes": [
      {
        "X": "1620957900",
        "Y": "0.4540"
      }
    ]
  },
  "FactorList": [
    {
      "FactorId": "1",
      "FaultSource": "LOCAL",
      "RelatedMetricDatas": [
        {
          "Role": "SENDER",
          "UserId": "testuserid2",
          "Type": "AUDIO_STUCK",
          "Nodes": [
            {
              "X": "1615892596",
              "Y": "20",
              "Ext": {
                "test": "test",
                "test2": 1
              }
            }
          ]
        }
      ],
      "RelatedEventDatas": [
        {
          "UserId": "0a497933****",
          "Role": "SENDER",
          "EventDataItems": [
            {
              "Ts": 1614936817,
              "EventList": [
                {
                  "EventName": "开始发布",
                  "EventType": "USER",
                  "Ts": 1614936817
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "NetworkOperators": [
    "移动"
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizCreatedTsErrorA business CreatedTs error occurred.参数会议创建时间不准确。
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。
上一篇：DescribeFaultDiagnosisUserList - 获取异常诊断的用户明细列表下一篇：版本说明
文档推荐