调用DescribeLiveStreamPreloadTasks查询直播预热任务_视频直播(LIVE)-阿里云帮助中心

使用说明

调用本接口仅支持查询最近3天内的数据。

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveStreamPreloadTasks	系统规定参数。取值：DescribeLiveStreamPreloadTasks。
DomainName	String	是	example.com	播流域名。
TaskId	String	否	yourTaskId	任务ID。您可以通过调用SetLiveStreamPreloadTasks接口获取预热任务ID。
PlayUrl	String	否	rtmp://guide.aliyundoc.com/liveApp**/liveStream**	直播URL，支持批量设置多个直播URL，多个URL之间用逗号（,）分隔，不超过100个。
PageSize	Integer	否	10	每页大小，最大100，取值：1~100之间的任意整数。
PageNum	Integer	否	1	取得第几页，默认1。
Status	String	否	complete	任务状态。取值： complete：已完成。 pending：等待预热。 preloading：预热中。 failed：预热失败。
StartTime	String	否	2016-06-29T19:00:00Z	起始时间，UTC格式，例如：2016-06-29T19:00:00Z，开始时间必须在近3天内。
EndTime	String	否	2016-06-30T19:00:00Z	结束时间，UTC格式，例如：2016-06-30T19:00:00Z，EndTime和StartTime之间的间隔不能超过3天。

返回数据

名称	类型	示例值	描述
PageNum	Integer	1	分页的页码。
PageSize	Integer	2	每页大小。
PreloadTasks	Array of PreloadTask		直播预热详情。
PreloadTask
Area	String	domestic	预热区域。取值： domestic：中国内地。 overseas：海外及港澳台加速。 global：全球加速。说明如果不传该参数，默认的预热区域为您的域名所配置的加速区域。
CreateTime	String	2016-06-29T19:00:00Z	预热任务创建时间。
Description	String	Successfully	预热任务是否成功。取值： Successfully：成功。 InternalError：失败。
DomainName	String	example.com	播流域名。
PlayUrl	String	rtmp://guide.aliyundoc.com/liveApp**/liveStream**	直播URL。
PreloadedEndTime	String	2016-06-30T19:00:00Z	预热结束时间。
PreloadedStartTime	String	2016-06-29T19:00:00Z	预热开始时间。
Process	String	100%	进度百分比。
Status	String	Success	任务状态。取值： Success：成功。 Failed：失败。说明只要有一条任务创建失败即为失败
TaskId	String	yourTaskId	任务ID。
RequestId	String	E1564CBC-DCFE-5E1B-8B78-8DED9A39F334	请求ID。
TotalNum	Integer	1	符合条件的总个数。
TotalPage	Integer	1	总页数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamPreloadTasks
&DomainName=example.com
&TaskId=yourTaskId
&PlayUrl=rtmp://guide.aliyundoc.com/liveApp****/liveStream****
&PageSize=10
&PageNum=1
&Status=complete
&StartTime=2016-06-29T19:00:00Z
&EndTime=2016-06-30T19:00:00Z
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

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

{
  "PageNum" : 1,
  "PageSize" : 2,
  "PreloadTasks" : [ {
    "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
}

错误码

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