全部產品
Search

搜尋本產品

    ApsaraVideo Live：SetLiveStreamPreloadTasks

    文件中心

    ApsaraVideo Live：SetLiveStreamPreloadTasks

    更新時間：Jun 22, 2026

    設定直播預熱任務，支援批量設定直播流預熱。

    介面說明

    • 呼叫本介面可支援批量設定直播流預熱，最多可一次性設定 100 個直播 URL。

    • 直播預熱僅不支援 HLS 格式的地址。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:SetLiveStreamPreloadTasks

    none

    *Domain

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地域 ID。

    cn-shanghai
    DomainName

    string

    是

    播流域名。

    example.com
    PlayUrl

    string

    是

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

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

    string

    否

    預熱區域。取值：

    • domestic：中國內地。

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

    • global：全球加速。

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

    枚舉值：

    • domestic :

      中國內地。

    • global :

      全球加速。

    • overseas :

      海外及港澳台加速。

    domestic
    PreloadedStartTime

    string

    否

    預熱開始時間，UTC 格式，例如：2016-06-29T19:00:00Z，不填預設預熱 1 小時。

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

    string

    否

    預熱結束時間，UTC 格式，例如：2016-06-30T19:00:00Z，EndTime 和 StartTime 之間的間隔不能超過 6 小時。

    2016-06-30T19:00:00Z

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    FailedURL

    integer

    預熱任務設定失敗的 URL 條數。

    0
    PreloadTasksMessages

    object

    PreloadTasksMessage

    array<object>

    直播預熱詳細資訊。

    object

    直播預熱詳細資訊。

    Description

    string

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

    • Successfully：成功。

    • InternalError：失敗。

    Successfully
    PlayUrl

    string

    直播 URL。

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

    string

    任務 ID。

    yourTaskId
    RequestId

    string

    請求 ID。

    36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5
    Status

    string

    任務狀態。取值：

    • Success：成功。

    • Failed：失敗。

    說明

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

    Success
    SuccessURL

    integer

    預熱任務設定成功的 URL 條數。

    1
    TotalURL

    integer

    預熱任務裡 URL 總條數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "FailedURL": 0,
  "PreloadTasksMessages": {
    "PreloadTasksMessage": [
      {
        "Description": "Successfully",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5",
  "Status": "Success",
  "SuccessURL": 1,
  "TotalURL": 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.
    400 QuotaExceeded.PreloadTaskslimit Exceed max task count limit
    400 NoSpecialConfiguration no special configuration for domain name.
    500 InternalError The request processing has failed due to backend service exception.

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

    變更歷史

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