全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeLiveStreamPreloadTasks

    文件中心

    ApsaraVideo Live：DescribeLiveStreamPreloadTasks

    更新時間：Jun 22, 2026

    僅支援查詢最近3天內的資料。

    介面說明

    本介面僅支援查詢最近 3 天內的資料。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeLiveStreamPreloadTasks

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    DomainName

    string

    是

    播流域名。

    example.com
    TaskId

    string

    否

    任務 ID。您可以透過呼叫 SetLiveStreamPreloadTasks 介面取得預熱任務 ID。

    yourTaskId
    PlayUrl

    string

    否

    直播 URL，支援批次設定多個直播 URL，多個 URL 之間用逗號（,）分隔，不超過 100 個。

    rtmp://guide.aliyundoc.com/liveApp****/liveStream****
    PageSize

    integer

    否

    每頁大小，最大 100，取值：1~100 之間的任意整數。

    10
    PageNum

    integer

    否

    取得第幾頁，預設 1。

    1
    Status

    string

    否

    任務狀態。取值：

    • complete：已完成。

    • pending：等待預熱。

    • preloading：預熱中。

    • failed：預熱失敗。

    枚舉值：

    • pending :

      等待預熱。

    • preloading :

      預熱中。

    • failed :

      預熱失敗。

    • complete :

      已完成。

    complete
    StartTime

    string

    否

    起始時間，日期格式按照 ISO8601 表示法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ，開始時間必須在近 3 天內。

    2016-06-29T19:00:00Z
    EndTime

    string

    否

    結束時間，日期格式按照 ISO8601 表示法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ，EndTime 和 StartTime 之間的間隔不能超過 3 天。

    2016-06-30T19:00:00Z

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageNum

    integer

    分頁的頁碼。

    1
    PageSize

    integer

    每頁大小。

    2
    PreloadTasks

    object

    PreloadTask

    array<object>

    直播預熱詳情。

    object

    直播預熱詳情。

    Area

    string

    預熱地區。取值：

    • domestic：中國內地。

    • overseas：海外及港澳台加速。

    • global：Global Acceleration。

    說明

    如果不傳該參數，預設的預熱地區為您的網域名稱所配置的加速地區。

    domestic
    CreateTime

    string

    預熱任務建立時間。

    2016-06-29T19:00:00Z
    Description

    string

    預熱任務是否成功。取值：

    • Successfully：成功。

    • InternalError：失敗。

    Successfully
    DomainName

    string

    播流網域名稱。

    example.com
    PlayUrl

    string

    直播 URL。

    rtmp://guide.aliyundoc.com/liveApp****/liveStream****
    PreloadedEndTime

    string

    預熱結束時間。

    2016-06-30T19:00:00Z
    PreloadedStartTime

    string

    預熱開始時間。

    2016-06-29T19:00:00Z
    Process

    string

    進度百分比。

    100%
    Status

    string

    任務狀態。取值：

    • Success：成功。

    • Failed：失敗。

    說明

    只要有一條任務建立失敗即為失敗

    Success
    TaskId

    string

    任務 ID。

    yourTaskId
    RequestId

    string

    請求 ID。

    E1564CBC-DCFE-5E1B-8B78-8DED9A39F334
    TotalNum

    integer

    符合條件的總個數。

    1
    TotalPage

    integer

    總頁數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "PageNum": 1,
  "PageSize": 2,
  "PreloadTasks": {
    "PreloadTask": [
      {
        "Area": "domestic",
        "CreateTime": "2016-06-29T19:00:00Z",
        "Description": "Successfully",
        "DomainName": "example.com",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "PreloadedEndTime": "2016-06-30T19:00:00Z",
        "PreloadedStartTime": "2016-06-29T19:00:00Z",
        "Process": "100%",
        "Status": "Success",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "E1564CBC-DCFE-5E1B-8B78-8DED9A39F334",
  "TotalNum": 1,
  "TotalPage": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParam Parameter invalid.
    400 InvalidEndTime.Mismatch Specified end time does not match the specified start time.
    400 Duration.Exceed Duration between StartTime and EndTime is too long.
    500 InternalError The request processing has failed due to backend service exception.

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

    變更歷史

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