DescribeLivePullToPush - 查询拉流转推任务_视频直播(LIVE)-阿里云帮助中心

调用DescribeLivePullToPush查询拉流转推任务。

接口说明

调用本接口查询拉流转推任务。
支持查询指定 ID 的任务配置信息和状态信息。

QPS 限制

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLivePullToPush

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-shanghai
TaskId	string	是	任务 ID。	fd245384-4067-4f91-9d75-9666a6bc****
Region	string	是	指定任务启动所在区域，取值： ap-southeast-1（新加坡） ap-southeast-5（印度尼西亚） cn-beijing（北京） cn-shanghai（上海）	cn-shanghai

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	a05e6b15-15af-405b-a4a2-0152245d****
RetCode	integer	返回码。说明正常情况返回“0”。异常情况请参考下文错误码列表。	0
Description	string	错误描述。	OK
TaskId	string	新建任务 ID。	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatus	integer	任务当前状态： 0：未启动（未到开始时间）。 1：正常运行（拉流和转推正常）。 2：异常运行。 3：已停止（拉流或转推异常，也有可能是主动调用接口停止）. -1：已退出。	0
TaskInvalidReason	string	任务停止运行原因： PullStreamFailed：源流拉流异常，重试中。 PushStreamFailed：目标流推流异常，重试中。 UnknownError：未知异常。说明仅停止运行状态下返回。	PullStreamFailed
TaskExitTime	integer	任务退出时间，Unix 秒级时间戳。说明仅已退出状态下返回。	1726354625
TaskExitReason	string	任务退出原因： TriggerByUser：用户主动结束。 OverEndTime：超过预设结束时间。说明仅已退出状态下返回。	TriggerByUser
CurrentOffset	integer	当前生效的视频播放偏移。	0
CurrentFileIndex	integer	当前生效的节目单序列偏移。	0
TaskInfo	object	任务信息。
TaskId	string	任务 ID。	fd245384-4067-4f91-9d75-9666a6bc9****
TaskName	string	任务名称。	test
StartTime	string	任务开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-08-26T10:30:00Z
EndTime	string	任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2024-08-27T14:30:00Z
SourceType	string	源流类型，枚举值： live，直播流。 vod，阿里云视频点播资源。 url，第三方视频文件资源。	vod
SourceProtocol	string	源流协议名。	RTMP
SourceUrls	array	源流 URL 地址。	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
	string	源流 URL 地址。	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
DstUrl	string	推流目标地址。	rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
CallbackURL	string	HTTP 回调地址。	https://callback*****.com
Offset	integer	启动偏移，视频文件起始偏移值。单位：秒。取值：大于 0。说明表示从相对于首帧的偏差时间作为开始读取的位置。仅对点播资源或视频文件有效。	0
FileIndex	integer	文件索引，从第 n 个文件开始播放起。	0
RetryCount	integer	重试次数。	3
RetryInterval	integer	重试间隔，单位秒。	60
RepeatNumber	integer	播放完后重复继续播放的次数。取值： 0（默认值）：不重复播放。 -1：一直循环重复。其他正整数：播放完后重复继续播放的次数。说明此参数仅针对点播或第三方视频流。	0

示例

正常返回示例

JSON格式

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "RetCode": 0,
  "Description": "OK",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
  "TaskStatus": 0,
  "TaskInvalidReason": "PullStreamFailed",
  "TaskExitTime": 1726354625,
  "TaskExitReason": "TriggerByUser",
  "CurrentOffset": 0,
  "CurrentFileIndex": 0,
  "TaskInfo": {
    "TaskId": "fd245384-4067-4f91-9d75-9666a6bc9****",
    "TaskName": "test",
    "StartTime": "2024-08-26T10:30:00Z",
    "EndTime": "2024-08-27T14:30:00Z",
    "SourceType": "vod",
    "SourceProtocol": "RTMP",
    "SourceUrls": [
      "rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434"
    ],
    "DstUrl": "rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434",
    "CallbackURL": "https://callback*****.com",
    "Offset": 0,
    "FileIndex": 0,
    "RetryCount": 3,
    "RetryInterval": 60,
    "RepeatNumber": 0
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	%s.	参数错误
400	CodeInvalidAliUid	This aliuid does not have a live domain name.	这个aluid没有直播域名
500	InternalError	%s.	直播 liveapi 服务端错误。

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

变更历史

更多信息，参考变更详情。