互动白板
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 互动白板 > 开发指南 > 事件通知 > 任务告警事件

任务告警事件

最近更新时间：2024-01-26 21:31:21

我的收藏

本页目录：

概述

告警事件回调是通过客户在控制台或调用设置API设置的回调地址进行事件回调。其目的是将当前正在运行的存量任务的异常情况以告警事件的方式通知客户，以方便客户感知异常并做出相应的决策。


告警事件说明

任务排队数量超过指定阈值告警事件

事件类型
TaskQueuedAmountLimitWarning
事件说明
当客户发起的任务没有被及时执行处于排队状态，且排队任务数超过指定告警阈值时，发送当前事件通知客户后台。
EventData 数据结构定义
参数名称
类型
描述
TaskType
String
任务类型，目前已有类型如下：
TranscodeH5：动态转码任务，文档转 HTML5 页面
TranscodeJPG：静态转码任务，文档转图片
WhiteboardPush：白板推流任务
OnlineRecord：实时录制任务
Total
Integer
排队任务总数
Tasks
Object
排队任务列表
Tasks.TaskID
String
任务 ID
Tasks.CreateTime
String
任务创建时间
Tasks.CancelTime
String
任务取消时间
Tasks.RoomID
Integer
任务所在房间号，转码任务没有房间号
Tasks.FileURL
String
转码任务指定的转码文件原始URL
Task.SdkAppID
Integer
应用 SdkAppID
示例
以白板推流为例：
{
  "EventType": "TaskQueuedAmountLimitWarning",
  "EventData": {
    "TaskType": "WhiteboardPush",
    "Total": 1,
    "Tasks": [
      {
          "TaskID": "bj0mt2l23osdj300hl31",
          "CreateTime": "2023-03-14 15:00:00",
          "CancelTime": "",
          "RoomID": 12345,
          "FileURL": "",
          "SdkAppID": 1400000001
      }
    ]
  }
}

任务排队等待时长超过指定阈值告警事件

事件类型
TaskQueuedTimeLimitWarning
事件说明
当客户发起的任务没有被及时执行处于排队状态，且排队任务等待时间超过指定告警阈值时，发送当前事件通知客户后台。
EventData 数据结构定义
参数名称
类型
描述
TaskType
String
任务类型，目前已有类型如下：
TranscodeH5：动态转码任务，文档转 HTML5 页面
TranscodeJPG：静态转码任务，文档转图片
WhiteboardPush：白板推流任务
OnlineRecord: 实时录制任务
Total
Integer
排队任务总数
Tasks
Object
排队任务列表
Tasks.TaskID
String
任务 ID
Tasks.CreateTime
String
任务创建时间
Tasks.CancelTime
String
任务取消时间
Tasks.RoomID
Integer
任务所在房间号，转码任务没有房间号
Tasks.FileURL
String
转码任务指定的转码文件原始 URL
Task.SdkAppID
Integer
应用 SdkAppID
示例
以白板推流为例：
{
  "EventType": "TaskQueuedTimeLimitWarning",
  "EventData": {
    "TaskType": "WhiteboardPush",
    "Total": 1,
    "Tasks": [
      {
          "TaskID": "bj0mt2l23osdj300hl31",
          "CreateTime": "2023-03-14 15:00:00",
          "CancelTime": "",
          "RoomID": 12345,
          "FileURL": "",
          "SdkAppID": 1400000001
      }
    ]
  }
}

任务并发数量占比超过指定阈值告警事件

事件类型
TaskConcurrencyLimitWarning
事件说明
当客户发起了大量任务，且当前正在执行的任务数占允许的最大并发数的比例超过指定阈值时，发送当前事件通知客户后台。
EventData 数据结构定义
参数名称
类型
描述
TaskType
String
任务类型，目前已有类型如下：
TranscodeH5：动态转码任务，文档转 HTML5 页面
TranscodeJPG：静态转码任务，文档转图片
WhiteboardPush：白板推流任务
OnlineRecord：实时录制任务
NowRunning
Integer
当前已创建且正在执行的任务数
MaxAllowed
Integer
当前任务类型允许的最大并发数
示例
以白板推流为例：
{
  "EventType": "TaskConcurrentWarning",
  "EventData": {
    "TaskType": "WhiteboardPush",
    "NowRunning": 1,
    "MaxAllowed": 300
  }
}

任务异常告警事件

事件类型
TaskExceptionWarning
事件说明
当任务出现异常的时候，发送当前事件通知客户后台。
EventData 数据结构定义
参数名称
类型
描述
TaskType
String
任务类型，目前已有类型如下：
TranscodeH5：动态转码任务，文档转 HTML5 页面
TranscodeJPG：静态转码任务，文档转图片
WhiteboardPush：白板推流任务
OnlineRecord：实时录制任务
TaskInfo
Object
异常任务信息
TaskInfo.TaskID
String
任务 ID
TaskInfo.CreateTime
String
任务创建时间
TaskInfo.CancelTime
String
任务取消时间
TaskInfo.RoomID
Integer
任务所在房间号，转码任务没有房间号
TaskInfo.FileURL
String
转码任务指定的转码文件原始 URL
TaskInfo.SdkAppID
Integer
应用 SdkAppID
ExceptionInfos
Object
异常信息列表
ExceptionInfos.Type
String
异常类型，目前已有类型如下：
BoardError：白板发生异常
IMError： IM发生异常
TRTCError：TRTC发生异常
ExceptionInfos.Time
String
异常时间点
ExceptionInfos.Message
String
异常具体信息
示例
以白板推流为例：
{
  "TaskType": "WhiteboardPush",
  "TaskInfo": {
    "CancelTime": "",
    "CreateTime": "2023-08-16 14:58:34",
    "FileURL": "",
    "RoomID": 67042,
    "SdkAppID": 1400000001,
    "TaskID": "08g8hoso9bcobi677ejc"
  },
  "ExceptionInfos": [
    {
        "Type": "BoardError",
        "Time": "2023-08-16 15:42:59",
        "Message": "OnTEBImageStatusChanged, load image failed after refresh, boardID web_auto_test_user971_1692169788_3_#1692169788643, url https://example.com/3.jpg, status 4"
    }
  ]
}

中国站