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

调用DescribeLiveStreamPreloadTasks查询直播预热任务。

使用说明

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

QPS限制

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

请求参数

参数名	类型	是否必须	说明
Action	String	是	操作接口名，系统规定参数，取值：DescribeLiveStreamPreloadTasks。
DomainName	String	是	加速域名。
TaskId	String	否	任务ID。
PlayUrl	String	否	直播URL。
Status	String	否	任务状态。取值： complete：已完成，pending：等待预热， preloading：预热中， failed：预热失败。
StartTime	String	否	起始时间，UTC格式，例如：2016-06-29T19:00:00Z，开始时间必须在近3天内。
EndTime	String	否	结束时间，UTC格式，例如：2016-06-30T19:00:00Z，EndTime和StartTime之间的间隔不能超过3天。
PageNum	Integer	否	取得第几页，默认1。
PageSize	Integer	否	每页大小，最大100，取值：1~100之间的任意整数。

返回参数

名称	类型	描述
RequestId	String	请求ID。
PageNum	Integer	分页的页码。
PageSize	Integer	每页大小。
TotalPage	Integer	总页数。
TotalNum	Integer	符合条件的总个数。
PreloadTasks	PreloadTask[]	任务列表。
DomainName	String	加速域名。
TaskId	String	任务ID。
PlayUrl	String	直播URL。
Status	String	任务状态。
Description	String	资源预热详情。
Process	String	进度百分比。
Area	String	预热区域。
PreloadedStartTime	String	预热开始时间。
PreloadedEndTime	String	预热结束时间。
CreateTime	String	预热任务创建时间。

特殊错误码

错误代码	描述	Http 状态码	语义
InternalError	The request processing has failed due to some unknown error.	500	后台发生未知错误。
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	当前账户下未查到域名。
InvalidParam	Parameter invalid.	400	参数错误。
InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	400	结束时间与开始时间不匹配。
Duration.Exceed	StartTime needs to be within the last 7 days.	400	开始时间必须在近3天内。

示例

请求示例：

https://live.aliyuncs.com?Action=DescribeLiveStreamPreloadTasks&DomainName=example.com&PageSize=10&PageNum=1&<公共请求参数>

返回示例：

{
    "RequestId": "0D70427D-91E4-4349-AAD3-5511A5BB823B",
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 11,
    "TotalPage": 2,
    "PreloadTasks": {
        "PreloadTask": [
            {
                "DomainName": "example.com",
                "TaskId": "1f98da3c-4306-4ba2-901d-96582f1cdef9",
                "PlayUrl": "http://example.com/test/test.flv",
                "Status": "complete",
                "Description": "Successfully",
                "Process": "100%",
                "Area": "domestic",
                "PreloadedStartTime": "2023-03-14T03:02:48Z",
                "PreloadedEndTime": "2023-03-14T04:02:48Z"
            },
            {
                "DomainName": "example.com",
                "TaskId": "b108d053-53a4-474d-b1f4-eac031c7b1ec",
                "PlayUrl": "http://example.com/test/test1.flv",
                "Status": "complete",
                "Description": "Successfully",
                "Process": "100%",
                "Area": "domestic",
                "PreloadedStartTime": "2023-03-14T03:02:48Z",
                "PreloadedEndTime": "2023-03-14T04:02:48Z"
            }
        ]
	}
}