UpdateLivePullToPush - 更新拉流转推任务

调用UpdateLivePullToPush更新拉流转推任务。

接口说明

  • 调用本接口更新拉流转推任务。

  • 任务未到设置的开始时间,支持更新 SourceType、Region 和 DstUrl。

  • 任务运行中(含异常重试状态)仅支持更新 CallbackUrl 和 RepeatTime 且更新会立即生效。

  • 任务已停止,除 SourceType、Region 和 DstUrl,其他参数均允许更新。

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:UpdateLivePullToPush

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-beijing

TaskId

string

任务 ID。

fd245384-4067-4f91-9d75-9666a6bc****

Region

string

指定任务启动所在区域,取值:

  • ap-southeast-1(新加坡)

  • ap-southeast-5(印度尼西亚)

  • cn-beijing(北京)

  • cn-shanghai(上海)

cn-shanghai

StartTime

string

任务开始时间。

说明
  • 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

  • 若任务已经启动运行则更新无效。

2024-08-23T15:30:00Z

EndTime

string

任务结束时间。

说明
  • 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

  • EndTime 必须大于 StartTime。

  • EndTime 必须大于当前时间。

  • 若任务已结束退出则更新无效。

2024-08-27T14:30:00Z

SourceUrls

array

源流 URL 地址列表。

说明
  • live 类型仅支持填写 1 个完整直播播放 URL。

  • vod、url 类型可填写最多 30 个。

  • live 类型支持:rtmp、rtsp、srt、http-flv 协议。

  • vod 类型填写阿里云视频点播媒资 ID。

  • url 类型支持:mp4、http-flv 协议。

  • 针对直播源流可立即生效;针对视频文件源流,需要等当前正在播放视频结束后生效,生效后基于最新视频列表从头开始播放。

  • 需要在任务停止运行的状态下更新,重启后生效。

changedtesturl

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

RepeatNumber

integer

播放完后重复继续播放的次数。取值:

  • 0(默认值):不重复播放。

  • -1:一直循环重复。

  • 其他正整数:播放完后重复继续播放的次数。

说明
  • 此参数仅针对点播或第三方视频流。

  • 更新后可以立即生效。

0

Offset

integer

启动偏移,视频文件起始偏移值。单位:秒。取值:大于 0。

说明
  • 表示从相对于首帧的偏差时间作为开始读取的位置。

  • 此参数仅针对点播或第三方视频流。

  • 仅当播放视频列表第一个视频时有效。

  • 需要在任务停止运行的状态下更新,重启后生效。

2

CallbackUrl

string

回调地址,默认为空。

说明
  • 接收任务相关回调的地址。

  • 最大长度为 2000 个字符。

  • 不指定本参数则不会回调相关任务事件。

  • 仅当下一次事件触发时开始生效。

https://callback*****.com

FileIndex

integer

视频索引,默认值为 0。

说明

需要在任务停止运行的状态下更新,重启后生效。

0

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68*****

RetCode

integer

返回码。

说明
  • 正常情况返回“0”。

  • 异常情况请参考下文错误码列表。

0

Description

string

错误描述。

OK

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68*****",
  "RetCode": 0,
  "Description": "OK"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter %s. 参数错误
400 InvalidParam.CodeIllegalDuration %s. 开始时间应该小于结束时间。
400 CodeInvalidAliUid This aliuid does not have a live domain name. 这个aluid没有直播域名
400 CodeTaskNotExist Task does not exist. 任务不存在。
400 CodeTaskHasStarted The task has already started. 任务已经启动,无法更新。
500 InternalError %s. 直播 liveapi 服务端错误。

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

变更历史

更多信息,参考变更详情