全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeLivePullToPush - 查詢拉流轉推任務

    文件中心

    ApsaraVideo Live：DescribeLivePullToPush - 查詢拉流轉推任務

    更新時間：Oct 14, 2025

    調用DescribeLivePullToPush查詢拉流轉推任務。

    介面說明

    • 調用本介面查詢拉流轉推任務。

    • 支援查詢指定 ID 的任務配置資訊和狀態資訊。

    QPS 限制

    本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeLivePullToPush

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    TaskId

    string

    是

    任務 ID。

    fd245384-4067-4f91-9d75-9666a6bc****
    Region

    string

    是

    指定任務啟動所在地區，取值：

    • ap-southeast-1（新加坡）

    • ap-southeast-5（印尼）

    • cn-beijing（北京）

    • cn-shanghai（上海）

    cn-shanghai

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    a05e6b15-15af-405b-a4a2-0152245d****
    RetCode

    integer

    返回碼。

    說明

    • 正常情況返回“0”。

    • 異常情況請參考下文錯誤碼列表。

    0
    Description

    string

    錯誤描述。

    OK
    TaskId

    string

    建立任務 ID。

    fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
    TaskStatus

    integer

    任務目前狀態：

    • 0：未啟動（未到開始時間）。

    • 1：正常運行（拉流和轉推正常）。

    • 2：異常運行。

    • 3：已停止（拉流或轉推異常，也有可能是主動調用介面停止）.

    • -1：已退出。

    0
    TaskInvalidReason

    string

    任務停止運行原因：

    • PullStreamFailed：源流拉流異常，重試中。

    • PushStreamFailed：目標流推流異常，重試中。

    • UnknownError：未知異常。

    說明

    僅停止運行狀態下返回。

    PullStreamFailed
    TaskExitTime

    integer

    任務退出時間，Unix 秒級時間戳記。

    說明

    僅已退出狀態下返回。

    1726354625
    TaskExitReason

    string

    任務退出原因：

    • TriggerByUser：使用者主動結束。

    • OverEndTime：超過預設結束時間。

    說明

    僅已退出狀態下返回。

    TriggerByUser
    CurrentOffset

    integer

    當前生效的視頻播放位移。

    0
    CurrentFileIndex

    integer

    當前生效的節目單序列位移。

    0
    TaskInfo

    object

    任務資訊。

    TaskId

    string

    任務 ID。

    fd245384-4067-4f91-9d75-9666a6bc9****
    TaskName

    string

    任務名稱。

    test
    StartTime

    string

    任務開始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2024-08-26T10:30:00Z
    EndTime

    string

    任務結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2024-08-27T14:30:00Z
    SourceType

    string

    源流類型，枚舉值：

    • live，直播流。

    • vod，阿里雲ApsaraVideo for VOD資源。

    • url，第三方視頻檔案資源。

    vod
    SourceProtocol

    string

    源流協議名。

    RTMP
    SourceUrls

    array

    源流 URL 地址。

    rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

    string

    源流 URL 地址。

    rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
    DstUrl

    string

    推流目標地址。

    rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
    CallbackURL

    string

    HTTP 回調地址。

    https://callback*****.com
    Offset

    integer

    啟動位移，視頻檔案起始位移值。單位：秒。取值：大於 0。

    說明

    • 表示從相對於首幀的偏差時間作為開始讀取的位置。

    • 僅對點播資源或視頻檔案有效。

    0
    FileIndex

    integer

    檔案索引，從第 n 個檔案開始播放起。

    0
    RetryCount

    integer

    重試次數。

    3
    RetryInterval

    integer

    稍候再試，單位秒。

    60
    RepeatNumber

    integer

    播放完後重複繼續播放的次數。取值：

    • 0（預設值）：不重複播放。

    • -1：一直迴圈重複。

    • 其他正整數：播放完後重複繼續播放的次數。

    說明

    此參數僅針對點播或第三方視頻流。

    0

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
  "TaskStatus": 0,
  "TaskInvalidReason": "PullStreamFailed",
  "TaskExitTime": 1726354625,
  "TaskExitReason": "TriggerByUser",
  "CurrentOffset": 0,
  "CurrentFileIndex": 0,
  "TaskInfo": {
    "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****",
    "TaskName": "test",
    "StartTime": "2024-08-26T10:30:00Z",
    "EndTime": "2024-08-27T14:30:00Z",
    "SourceType": "vod",
    "SourceProtocol": "RTMP",
    "SourceUrls": [
      "rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434"
    ],
    "DstUrl": "rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434",
    "CallbackURL": "https://callback*****.com",
    "Offset": 0,
    "FileIndex": 0,
    "RetryCount": 3,
    "RetryInterval": 60,
    "RepeatNumber": 0
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter %s. 參數錯誤
    400 CodeInvalidAliUid This aliuid does not have a live domain name. 這個aluid沒有直播網域名稱
    500 InternalError %s. 直播 liveapi 服務端錯誤。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。