调用InitializeAutoShowListTask创建一个定时任务。
使用说明
本接口支持配置定时启停一个播单定时任务,调用时请保证参数设置符合要求。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | InitializeAutoShowListTask |
系统规定参数。取值:InitializeAutoShowListTask。 |
ResourceIds | String | 是 | ["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"] |
播单中的点播媒资文件ID列表(目前仅支持点播视频文件)。 最多支持三个节目,每个节目会按照列表顺序进行播放直到EndTime会自动结束。 说明
|
StartTime | Long | 是 | 1645688994000 |
开始时间戳,单位:毫秒。 |
EndTime | Long | 是 | 1645688994000 |
结束时间戳,单位:毫秒。 |
CasterConfig | String | 是 | {"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]} |
导播台配置。包含:
说明 JSON格式字符串,结构体内部字段请按首字母大写,驼峰格式输入。
|
DomainName | String | 是 | example.aliyundoc.com |
输出的播流域名。 |
CallBackUrl | String | 否 | http://***.com/callback |
用户回调地址。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
StreamList | String | [{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}] |
导播台输出地址列表。
|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
请求ID。 |
CasterId | String | b4810848-bcf9-4aef-bd4a-e6bba2d9**** |
导播台ID。 说明 可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。
|
示例
请求示例
http(s)://live.aliyuncs.com/?Action=InitializeAutoShowListTask
&CasterConfig={"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]}
&DomainName=example.aliyundoc.com
&EndTime=1645688994000
&ResourceIds=["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"]
&StartTime=1645688994000
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<InitializeAutoShowListTaskResponse>
<RequestId>9F6448C9-6F92-1BAC-AFDD-C308782A6573</RequestId>
<StreamList>
<videoFormat>flv</videoFormat>
<outputStreamUrl>http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****.flv</outputStreamUrl>
<transcodeConfig>original</transcodeConfig>
</StreamList>
<CasterId>6277b6a3-1a40-4063-85f7-145666e3****</CasterId>
</InitializeAutoShowListTaskResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9F6448C9-6F92-1BAC-AFDD-C308782A6573",
"StreamList" : [ {
"videoFormat" : "flv",
"outputStreamUrl" : "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****.flv",
"transcodeConfig" : "original"
} ],
"CasterId" : "6277b6a3-1a40-4063-85f7-145666e3****"
}
错误码
访问错误中心查看更多错误码。
示例代码
public void InitializeAutoShowListTask() throws ClientException {
CommonRequest initializeAutoShowListTaskRequest = new CommonRequest()
initializeAutoShowListTaskRequest.setAction("InitializeAutoShowListTask");
initializeAutoShowListTaskRequest.setDomain("live.aliyuncs.com");
initializeAutoShowListTaskRequest.setVersion("2016-11-01");
JSONArray resourceIds = new JSONArray();
resourceIds.add("xxx1");
initializeAutoShowListTaskRequest.putQueryParameter("ResourceIds", resourceIds.toJSONString());
long currentTimeMillis = System.currentTimeMillis();
//播放一分钟时长,在30秒后启动
long startTime = currentTimeMillis + 30 * 1000;
long endTime = startTime + 1 * 60 * 1000;
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
// 时间戳转换成时间
String start = sdf.format(new Date(Long.parseLong(String.valueOf(startTime))));
// 时间戳转换成时间
String end = sdf.format(new Date(Long.parseLong(String.valueOf(endTime))));
System.out.printf("格式化结果:start %s end %s\n", start, end);
initializeAutoShowListTaskRequest.putQueryParameter("StartTime", String.valueOf(startTime));
initializeAutoShowListTaskRequest.putQueryParameter("EndTime", String.valueOf(endTime));
JSONObject casterConfig = new JSONObject();
casterConfig.put("CasterTemplate", "lp_hd");
JSONArray liveTemplate = new JSONArray();
liveTemplate.add("lhd");
liveTemplate.add("lsd");
casterConfig.put("LiveTemplate", liveTemplate);
initializeAutoShowListTaskRequest.putQueryParameter("CasterConfig", casterConfig.toJSONString());
initializeAutoShowListTaskRequest.putQueryParameter("DomainName", "testdomainplay.alivecdn.com");
DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
CommonResponse commonResponse = client.getCommonResponse(initializeAutoShowListTaskRequest);
System.out.printf("Status is %s and Response is:\n", commonResponse.getHttpStatus());
JSONObject jsonObject = JSON.parseObject(commonResponse.getData());
System.out.println(JSON.toJSONString(jsonObject, true));
}
JSON格式返回示例
{
"RequestId": "9F6448C9-6F92-1BAC-AFDD-C308782A6573",
"StreamList": [
{
"videoFormat": "flv",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****.flv",
"transcodeConfig": "original"
},
{
"videoFormat": "rtmp",
"outputStreamUrl": "rtmp://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****",
"transcodeConfig": "original"
},
{
"videoFormat": "m3u8",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****.m3u8",
"transcodeConfig": "original"
},
{
"videoFormat": "flv",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lhd.flv",
"transcodeConfig": "lhd"
},
{
"videoFormat": "rtmp",
"outputStreamUrl": "rtmp://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lhd",
"transcodeConfig": "lhd"
},
{
"videoFormat": "m3u8",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lhd.m3u8",
"transcodeConfig": "lhd"
},
{
"videoFormat": "flv",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lsd.flv",
"transcodeConfig": "lsd"
},
{
"videoFormat": "rtmp",
"outputStreamUrl": "rtmp://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lsd",
"transcodeConfig": "lsd"
},
{
"videoFormat": "m3u8",
"outputStreamUrl": "http://example.aliyundoc.com/caster/2967b3b2b52242019c277de2a11a****_lsd.m3u8",
"transcodeConfig": "lsd"
}
],
"CasterId": "6277b6a3-1a40-4063-85f7-145666e3****"
}