拉流轉推事件回調 - ApsaraVideo Live

本文介紹拉流轉推事件回調觸發條件和回調內容樣本。

拉流轉推回調事件

拉流轉推回調事件包括拉流轉推任務運行狀態變化回調和拉流轉推任務已退出回調

其中拉流轉推任務狀態包括：

狀態	說明
未啟動（Idle）	調用API請求建立產生拉流轉推的任務初始狀態。
正常運行（Running）	到了設定開始時間自動啟動或任務被停止重新啟動後的狀態。
異常運行（Recovering）	任務運行過程中發生異常重試過程中的狀態。
已停止（Offline）	任務異常重試逾時自動停止或調用API請求停止後的狀態。
已退出（Exit）	超過設定結束時間自動刪除或調用API請求刪除後的狀態。

拉流轉推任務運行狀態變化回調

說明

當拉流轉推任務運行過程中狀態發生變化時觸發，包括：正常運行、異常運行和已停止。

觸發條件

到達預設開始時間任務自動啟動或調用API重啟任務，任務狀態變為Running
運行過程發生異常，任務狀態變為Recovering
使用者調用API停止任務或異常重試逾時，任務狀態變為Offline

拉流轉推任務已退出回調

說明

當拉流轉推任務退出時觸發，表示任務到期被清理。

觸發條件

任務執行超過預設結束時間，任務狀態變為Exit
使用者調用API刪除任務，任務狀態變為Exit

拉流轉推回調事件內容說明

回調內容為JSON格式，通過HTTP POST請求包含在請求體（Request Body）中發送到CallbackUrl回調地址中，解析請求體擷取回調內容。

拉流轉推任務運行狀態變化回調參數和樣本

表 1. 拉流轉推任務運行狀態變化回調內容說明

參數	描述
Event	事件名稱，固定值：`LivePullToPushRunning`
EventTime	事件發生時間，Unix 秒時間戳記。
TaskId	任務ID
TaskInfo	任務資訊
TaskStatus	任務目前狀態，取值： 1：正常運行（Running） 2：異常運行（Recovering） 3：已停止（Offline）
TaskInvalidReason	任務運行異常或停止啟動並執行原因，取值： `PullStreamFailed`：拉流失敗 `PushStreamFailed`：轉推失敗 `TriggerByUser`：使用者調用API `UnknownError`：未知原因 `RetryTimesOffline`：定時異常回調說明僅停止運行（Offline）情況下返回此參數。

拉流轉推任務運行狀態變化回調參數樣本

{
"Event": "LivePullToPushRuning",
"EventTime": "1725501246",
"TaskId": "08a1b00c-9c2f-4dfa-9f5d-878f2505****",
"TaskInfo": {
    "TaskId": "08a1b00c-9c2f-4dfa-9f5d-878f250****",
    "StartTime": "2024-09-05T01:54:00Z",
    "EndTime": "2024-09-05T01:58:00Z",
    "SourceUrls": [
      "\"http://fyl-*******-*****.oss-cn-beijing.aliyuncs.com/record/caster/741584e2557248e98ef332d41e4afc3d/2024-08-30-18:19:40_2024-08-30-18:21:09.mp4\""
    ],
    "DstUrl": "rtmp://pushtest.******.aliyunlive.com/pulltest38/pulltest-w38",
    "CallbackURL": "https://1833220977******.cn-shanghai.lc.aliyuncs.com/workflows/lc-uf6sd1382ikolc/triggers/manual/methods/invoke?ApiVersion=2018-12-12&Signature=TZT7CGDgc299cC2dtL73Yeq4xY8",
    "Offset": 0,
    "SourceType": "url"
  },
"TaskStatus": "1"
}

拉流轉推任務已退出回調參數和樣本

表 2. 拉流轉推任務已退出回調內容說明

參數	描述
Event	事件名稱，固定值：`LivePullToPushExit`
EventTime	事件發生時間，Unix 秒時間戳記。
TaskId	任務ID。
TaskInfo	任務資訊。
TaskStatus	任務目前狀態，取值： -1：已退出
TaskExitTime	任務退出時間，Unix 秒級時間戳記。
TaskExitReason	任務退出原因，取值： `TriggerByUser`：使用者調用API `OverEndTime`：超過預設結束時間

拉流轉推任務已退出回調參數樣本

{
  "Event": "LivePullToPushExit",
  "EventTime": "1725501483",
  "TaskId": "08a1b00c-9c2f-4dfa-9f5d-878f2505****",
  "TaskInfo":  {
    "TaskId": "08a1b00c-9c2f-4dfa-9f5d-878f2505****",
    "StartTime": "2024-09-05T01:54:00Z",
    "EndTime": "2024-09-05T01:58:00Z",
    "SourceUrls": [
      "\"http://fyl-******-****.oss-cn-beijing.aliyuncs.com/record/caster/741584e2557248e98ef332d41e4afc3d/2024-08-30-18:19:40_2024-08-30-18:21:09.mp4\""
    ],
    "DstUrl": "rtmp://pushtest.*****.aliyunlive.com/pulltest38/pulltest-w38",
    "CallbackURL": "https://1833220977******.cn-shanghai.lc.aliyuncs.com/workflows/lc-uf6sd1382ikolc/triggers/manual/methods/invoke?ApiVersion=2018-12-12&Signature=TZT7CGDgc299cC2dtL73Yeq4xY8",
    "Offset": 0,
    "SourceType": "url"
  },
  "TaskStatus": "-1",
  "TaskExitTime": "1725501483",
  "TaskExitReason": "OverEndTime",
}