CreateLivePullToPush - 创建拉流转推任务_视频直播(LIVE)-阿里云帮助中心

调用CreateLivePullToPush创建拉流转推任务。

接口说明

注意

拉流转推功能当前处于公测阶段，您可以免费使用，公测结束后将正常收费，具体时间另行通知。

调用本接口创建拉流转推任务。
支持创建直播拉流任务，也支持创建点播拉流任务。
任务创建后，到了设置的开始时间，会真正开始运行，到了设置的结束时间，会自动停止并删除清理。
任务中设置的推流目标地址需要确保未被其他任务使用，不然会因为多个任务同时转推相同地址导致推流失败。
拉流转推回调事件包括拉流转推任务运行状态变化回调和拉流转推任务已退出回调。更多信息，请参见拉流转推事件回调。

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作

操作	访问级别	资源类型	条件关键字	关联操作
live:CreateLivePullToPush	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
Region	string	是	指定任务启动所在区域，取值： ap-southeast-1（新加坡） ap-southeast-5（印度尼西亚） cn-beijing（北京） cn-shanghai（上海）	cn-shanghai
TaskName	string	否	任务名称，用于支持模糊查询，默认值为""。	test
StartTime	string	是	任务开始时间。说明格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 StartTime 和 EndTime 时间间隔在 7 天内。	2024-08-26T10:30:00Z
EndTime	string	是	任务结束时间。说明格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 StartTime 和 EndTime 时间间隔在 7 天内。 EndTime 必须大于 StartTime。 EndTime 必须大于当前时间。	2024-08-27T14:30:00Z
SourceType	string	是	源流类型，枚举值： live，直播流。 vod，阿里云视频点播资源。 url，第三方视频文件资源。	live
SourceProtocol	string	否	源流协议名。取值范围 rtmp rtsp srt http-flv flv 说明此参数仅当 sourcetype 参数取值为 live 时生效，取值为 vod、url 时无效。	rtmp
SourceUrls	array	是	源流 URL 地址列表。说明 live 类型仅支持填写 1 个完整直播播放 URL。 vod、url 类型可填写最多 30 个。 live 类型支持：rtmp、rtsp、srt、http-flv 协议。 vod 类型填写阿里云视频点播媒资 ID。 url 类型支持：mp4、http-flv 协议。
	string	是	源流 URL 地址。说明 live 类型仅支持填写 1 个完整直播播放 URL。 vod、url 类型可填写最多 30 个。 live 类型支持：rtmp、rtsp、srt、http-flv 协议。 vod 类型填写阿里云视频点播媒资 ID。 url 类型支持：mp4、http-flv 协议。	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
DstUrl	string	是	推流目标 URL 地址。说明支持 rtmp 协议。最大长度为 2000 个字符。	rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
RepeatNumber	integer	否	播放完后重复继续播放的次数。取值： 0（默认值）：不重复播放。 -1：一直循环重复。其他正整数：播放完后重复继续播放的次数。说明此参数仅针对点播或第三方视频流。	0
FileIndex	integer	否	文件索引，从第 n 个文件开始播放起。	0
Offset	integer	否	启动偏移，视频文件起始偏移值。单位：秒。取值：大于 0。说明表示从相对于首帧的偏差时间作为开始读取的位置（指第一个视频）。此参数仅针对点播或第三方视频流。	2
CallbackUrl	string	否	HTTP 回调地址，默认为空。说明接收任务相关回调的地址。最大长度为 2000 个字符。不指定本参数则不会回调相关任务事件。	https://callback*****.com
RetryInterval	integer	否	重试间隔，单位秒，取值区间[60,300]，默认 60 秒。	60
RetryCount	integer	否	重试次数，默认值为 3。	3

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68*****
RetCode	integer	返回码。说明正常情况返回“0”。异常情况请参考下文错误码列表。	0
Description	string	错误描述。	OK
TaskId	string	任务 ID。	fd245384-4067-4f91-9d75-9666a6bc9****

示例

正常返回示例

JSON格式

        
{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68*****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****"
}

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	%s.	参数错误
400	LiveServiceNotFound	Your account does not open Live service yet	您的账户尚未开通直播服务
500	InternalError	%s.	直播 liveapi 服务端错误。

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