DescribeFaultDiagnosisUserDetail - 获取异常诊断的用户详情-阿里云帮助中心

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

接口说明

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	APP ID。	0rbd****
ChannelId	string	是	频道 ID	311
CreatedTs	long	是	频道创建时间，使用 UNIX 时间戳表示，单位：秒。	1615892596
UserId	string	是	用户 ID	c906531af5f9****
FaultType	string	是	异常类型。取值： JOIN_SLOW：进频道慢。 AUDIO_STUCK：音频卡顿。 VIDEO_STUCK：视频卡顿。 VIDEO_VAGUE：视频模糊。 HIGH_DELAY：通话延迟高。 FIRST_FRAME_SLOW：接收首屏慢。	JOIN_SLOW
QueryCallUserInfo	boolean	否	是否查询通话用户信息，为空默认是 false。	true

返回参数

名称	类型	描述	示例值
	object
CallInfo	object	通信基本信息，QueryCallUserInfo=false 时返回。
AppId	string	App ID。	testappid
ChannelId	string	频道 ID。	311
CallStatus	string	通信状态。取值： IN：进行中。 OUT：已结束。	IN
CreatedTs	long	创建通信时间，使用 UNIX 时间戳表示，单位：秒。	1620957905
DestroyedTs	long	释放通信时间，使用 UNIX 时间戳表示，单位：秒。	1620958150
Duration	long	通信持续时长，单位：秒。	100
UserDetail	object	诊断用户详细信，QueryCallUserInfo=false 时返回。
UserId	string	用户 ID。	testuserid
Location	string	地理位置信息，例如：北京市-北京市。	浙江省-杭州市
OnlinePeriods	object []	在线时段信息。
JoinTs	long	加入通话时间，使用 UNIX 时间戳表示，单位：秒。	1620957919
LeaveTs	long	离开通话时间，使用 UNIX 时间戳表示，单位：秒。	1620958150
CreatedTs	long	创建通话时间，使用 UNIX 时间戳表示，单位：秒。	1620957919
DestroyedTs	long	释放通话时间，使用 UNIX 时间戳表示，单位：秒。	1620958150
OnlineDuration	long	在线时长，单位：秒。	231
Duration	long	通话时长，首次进入到最后离开，单位：秒。	231
SdkVersion	string	SDK 版本，如 1.0.0、1.1.1 等。	1.0.0
Os	string	平台类型：若用户客户端为 WEB 则是浏览器类型，若客户端为 NATIVE 则是操作系统类型。	iOS
Network	string	网络类型，如 WiFi，4G 等。	4G
FaultMetricData	object	异常指标。
Nodes	object []	指标坐标点列表。
X	string	指标趋势图中 x 轴横坐标，单位时间为 1 分钟。	1620957900
Y	string	指标趋势图中 y 轴纵坐标。	0.4540
FactorList	object []	影响因素列表，空表示影响因素未知。
FactorId	string	影响因素 ID，详情请参见下文中的影响因素 ID 取值。	1
FaultSource	string	异常来源 LOCAL：本端 REMOTE：远端。	LOCAL
RelatedMetricDatas	object []	关联的指标，坐标数据，当 FaultType 为 AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY 时返回。
Role	string	来源角色。取值： SENDER：发布端。 RECEIVER：订阅端。	SENDER
UserId	string	数据来自对应发布端的用户 ID。	testuserid2
Type	string	指标类型，参照端到端指标接口的指标类型。	AUDIO_STUCK
Nodes	object []	指标趋势图坐标点列表。
X	string	指标趋势图中 x 轴横坐标。	1615892596
Y	string	指标趋势图中 y 轴纵坐标。	20
Ext	object	扩展数据。
RelatedEventDatas	object []	关联的事件，按时间分组，当 FaultType 为 AUDIO_STUCK、VIDEO_STUCK、VIDEO_VAGUE、HIGH_DELAY 时返回坐标数据。
UserId	string	用户 ID	0a497933****
Role	string	来源角色。取值： SENDER：发布端。 RECEIVER：订阅端。	SENDER
EventDataItems	object []	事件数据列表。
Ts	long	第一个事件发生的时间，使用 UNIX 时间戳表示，单位：秒。	1614936817
EventList	object []	事件列表。
EventName	string	事件名称。	开始发布
EventType	string	事件类型。取值： USER：用户事件。 SYSTEM：系统事件。	USER
Ts	long	事件发生的时间，使用 UNIX 时间戳表示，单位：秒。	1614936817
NetworkOperators	array	网络运营商列表
	string	网络运营商。	移动
RequestId	string	请求 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	错误码	错误信息	描述
400	ApiParamError	API %s.	Api参数错误
403	BizCreatedTsError	A business CreatedTs error occurred.	参数会议创建时间不准确。
403	BizAppError	A business application permission error occurred.	业务应用权限错误
403	BizUidError	A business UID error occurred.	业务主账号错误
500	ServerInternalError	An internal error occurred.	服务器内部错误

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