调用SetLiveStreamPreloadTasks设置直播预热任务。
使用说明
调用本接口可支持批量设置直播流预热,最多可一次性设置100个直播URL。
直播预热仅不支持HLS格式的地址。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见视频直播API QPS限制。
请求参数
参数名 | 类型 | 是否必须 | 说明 |
Action | String | 是 | 操作接口名,系统规定参数,取值:SetLiveStreamPreloadTasks。 |
DomainName | String | 是 | 加速域名。 |
PlayUrl | String | 是 | 直播URL,支持批量设置多个直播URL,多个URL之间用逗号(,)分隔,不超过100个。 |
Area | String | 否 | 预热区域。取值:domestic:中国内地,overseas:海外及港澳台加速,global:全球加速。 如果不传该参数,默认的预热区域为您的域名所配置的加速区域。 |
PreloadedStartTime | String | 否 | 预热开始时间,UTC格式,例如:2016-06-29T19:00:00Z,不填默认预热1小时。 |
PreloadedEndTime | String | 否 | 预热结束时间,UTC格式,例如:2016-06-30T19:00:00Z,EndTime和StartTime之间的间隔不能超过6小时。 |
返回参数
名称 | 类型 | 描述 |
RequestId | String | 请求ID。 |
Status | String | 任务状态。取值:Success:成功,Failed:失败。 说明 只要有一条任务创建失败即为失败。 |
TotalURL | Integer | 预热任务里URL总条数。 |
SuccessURL | Integer | 预热任务设置成功的URL条数。 |
FailedURL | Integer | 预热任务设置失败的URL条数。 |
PreloadTasksMessages | PreloadTasksMessage[] | 所有预热的URL的详细信息。 |
TaskId | String | 任务ID。 |
PlayUrl | String | 直播URL。 |
Description | 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 | Duration between StartTime and EndTime is too long. | 400 | 结束时间与开始时间间隔太长。 |
QuotaExceeded.PreloadTaskslimit | Exceed max task count limit | 400 | 任务数量过多。 |
示例
请求示例:
https://live.aliyuncs.com?Action=SetLiveStreamPreloadTasks&DomainName=example.com&PlayUrl=http://example.com/test/test1.flv,http://example.com/test/test2.flv&<公共请求参数>
返回示例:
{
"RequestId": "0D70427D-91E4-4349-AAD3-5511A5BB823B",
"Status": "Success",
"TotalURL": 2,
"SuccessURL": 2,
"FailedURL": 0,
"PreloadTasksMessages": {
"PreloadTasksMessage": [
{
"TaskId": "1f98da3c-4306-4ba2-901d-96582f1cdef9",
"PlayUrl": "http://example.com/test/test1.flv",
"Description": ""
},
{
"TaskId": "1f98da3c-4306-4ba2-901d-96582f1cdef9",
"PlayUrl": "http://example.com/test/test2.flv",
"Description": ""
}
]
}
}
- 本页导读 (1)