文档

设置直播预热任务

调用SetLiveStreamPreloadTasks设置直播预热任务。

使用说明

  • 调用本接口可支持批量设置直播流预热,最多可一次性设置100个直播URL。
  • 直播预热仅不支持HLS格式的地址。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String SetLiveStreamPreloadTasks

系统规定参数。取值:SetLiveStreamPreloadTasks

DomainName String example.com

播流域名。

PlayUrl String rtmp://guide.aliyundoc.com/liveApp****/liveStream****

直播URL,支持批量设置多个直播URL,多个URL之间用逗号(,)分隔,不超过100个。

Area String domestic

预热区域。取值:

  • domestic:中国内地。
  • overseas:海外及港澳台加速。
  • global:全球加速。

    如果不传该参数,默认的预热区域为您的域名所配置的加速区域。

PreloadedStartTime String 2016-06-29T19:00:00Z

预热开始时间,UTC格式,例如:2016-06-29T19:00:00Z,不填默认预热1小时。

PreloadedEndTime String 2016-06-30T19:00:00Z

预热结束时间,UTC格式,例如:2016-06-30T19:00:00Z,EndTime和StartTime之间的间隔不能超过6小时。

返回数据

名称

类型

示例值

描述

FailedURL Integer 0

预热任务设置失败的URL条数。

PreloadTasksMessages Array of PreloadTasksMessage

直播预热详细信息。

PreloadTasksMessage
Description String Successfully

预热任务是否成功。取值:

  • Successfully:成功。
  • InternalError:失败。
PlayUrl String rtmp://guide.aliyundoc.com/liveApp****/liveStream****

直播URL。

TaskId String yourTaskId

任务ID。

RequestId String 36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5

请求ID。

Status String Success

任务状态。取值:

  • Success:成功。
  • Failed:失败。
说明 只要有一条任务创建失败即为失败。
SuccessURL Integer 1

预热任务设置成功的URL条数。

TotalURL Integer 1

预热任务里URL总条数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=SetLiveStreamPreloadTasks
&DomainName=example.com
&PlayUrl=rtmp://guide.aliyundoc.com/liveApp****/liveStream****
&Area=domestic
&PreloadedStartTime=2016-06-29T19:00:00Z
&PreloadedEndTime=2016-06-30T19:00:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SetLiveStreamPreloadTasksResponse>
    <FailedURL>0</FailedURL>
    <PreloadTasksMessages>
        <Description>Successfully</Description>
        <PlayUrl>rtmp://guide.aliyundoc.com/liveApp****/liveStream****</PlayUrl>
        <TaskId>yourTaskId</TaskId>
    </PreloadTasksMessages>
    <RequestId>36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5</RequestId>
    <Status>Success</Status>
    <SuccessURL>1</SuccessURL>
    <TotalURL>1</TotalURL>
</SetLiveStreamPreloadTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "FailedURL" : 0,
  "PreloadTasksMessages" : [ {
    "Description" : "Successfully",
    "PlayUrl" : "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
    "TaskId" : "yourTaskId"
  } ],
  "RequestId" : "36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5",
  "Status" : "Success",
  "SuccessURL" : 1,
  "TotalURL" : 1
}

错误码

访问错误中心查看更多错误码。