创建一个定时任务。
接口说明
本接口支持配置定时启停一个播单定时任务,调用时请保证参数设置符合要求。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:InitializeAutoShowListTask |
get |
*Caster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| ResourceIds |
string |
否 |
播单中的点播媒资文件 ID 列表(目前仅支持点播平台的 mp4 格式视频文件)。 最多支持三个节目,每个节目会按照列表顺序进行播放直到 EndTime 会自动结束。 说明
|
["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"] |
| StartTime |
integer |
是 |
开始时间戳,单位:毫秒。 |
1645688994000 |
| EndTime |
integer |
是 |
结束时间戳,单位:毫秒。 |
1645688994000 |
| CasterConfig |
string |
是 |
导播台配置。包含:
说明
JSON 格式字符串,结构体内部字段请按首字母大写,驼峰格式输入。 |
{"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]} |
| DomainName |
string |
是 |
输出的播流域名。 |
example.aliyundoc.com |
| CallBackUrl |
string |
否 |
用户回调地址。 |
http://***.com/callback |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| CasterId |
string |
导播台 ID。 说明
可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。 |
b4810848-bcf9-4aef-bd4a-e6bba2d9**** |
| RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
| StreamList |
string |
导播台输出地址列表。
|
[{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}] |
示例
正常返回示例
JSON格式
{
"CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"StreamList": "[{\"videoFormat\":\"flv\",\"outputStreamUrl\":\"http://example.aliyundoc.com\",\"transcodeConfig\":\"original\"}]"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.PurchaseTime | %s, please check and try again later. | 参数PurchaseTime无效,请检查后重试。 |
| 400 | InvalidParameter.ExpireTime | %s, please check and try again later. | 参数ExpireTime无效,请检查后重试。 |
| 400 | MissingParameter | %s. | 参数缺失 |
| 400 | InvalidChargeType.Malformed | %s, please check and try again later. | 参数ChargeType无效,请检查后重试。 |
| 400 | InvalidChargeType.PostSupport | %s, please check and try again later. | ChargeType仅支持后付费,请检查后重试。 |
| 400 | InvalidCasterTemplate.Malformed | %s, please check and try again later. | 参数CasterTemplate无效,请检查后重试。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在无效参数:%s。 |
| 400 | InvalidParameter.ChargeType | %s, please check and try again later. | 参数ChargeType无效,请检查后重试。 |
| 400 | InvalidPeriod.Malformed | %s, please check and try again later. | 时间间隔无效,请检查后重试。 |
| 400 | InvalidClientToken.Malformed | %s, please check and try again later. | 参数ClientToken无效,请检查后重试。 |
| 400 | IncorrectCasterStatus | %s, please check and try again later. | 导播台状态有误,请检查后重试。 |
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | 参数CasterId无效,请检查后重试。 |
| 400 | InvalidUserId.Malformed | %s, please check userId. | 传入的userId无效,请检查。 |
| 400 | InvalidParameter.StartTime | %s, please check and try again later. | 参数StartTime无效,请检查后重试。 |
| 401 | CasterNumberExceed | %s, please check and try again later. | 导播台数量超限,请检查后重试。 |
| 401 | IllegalOperation | %s, please check and try again later. | 不允许的操作,请检查后重试。 |
| 500 | InternalError | %s, please try again later. | 内部错误,请稍后重试。 |
| 404 | IncorrectCasterStatus.EnableChannel | %s, please check and try again later. | 导播台状态不支持EnableChannel设置,请检查后重试。 |
| 404 | InvalidParameter.NormType | %s, please check and try again later. | 参数NormType无效,请检查后重试。 |
| 404 | InvalidConfiguration.NotFound | %s, please check and try again later. | 配置不存在,请检查后重试。 |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | 导播台不存在,请检查后重试。 |
| 404 | InvalidDomainName.NotFound | %s, please check and try again later. | 域名不存在,请检查后重试。 |
| 408 | CreateCaster.Timeout | %s, please try again later. | 调用CreateCaster超时,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。