DescribeLivePullToPushList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries pull-to-push tasks using a fuzzy query.

Operation description

Queries a list of pull-to-push tasks.
This operation supports paged queries and fuzzy searches by task ID, task name, or destination ingest URL.

QPS limits

The queries per second (QPS) limit for this operation is 10 calls per second per user. If you exceed this limit, your API calls are throttled. To prevent your business operations from being affected, call this operation within the specified limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLivePullToPushList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Region	string	Yes	The live center to query. Valid values: ap-southeast-1 (Singapore) ap-southeast-5 (Indonesia) cn-beijing (Beijing) cn-shanghai (Shanghai)	cn-shanghai
TaskId	string	No	The task ID. This parameter supports fuzzy search. Note The task ID can be up to 55 characters long and can consist of uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).	861009
TaskName	string	No	The name of the task. Fuzzy search is supported.	task
DstUrl	string	No	The destination ingest URL for the fuzzy search.	rtmp://qd
PageNumber	integer	No	The page number. Note The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Note The value must be between 1 and 100. The default value is 10.	10

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	a05e6b15-15af-405b-a4a2-0152245*****
Total	integer	The total number of query results.	3
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries on each page.	10
TaskList	array<object>	A list of task information.
	array<object>	A list of task information.
TaskId	string	The task ID.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatus	integer	The current status of the task: 0: Not started (The start time has not been reached). 1: Running (Stream pulling and stream ingest are normal). 2: Abnormal. 3: Stopped (An exception occurred during stream pulling or stream ingest, or the task was manually stopped by an API call). -1: Exited.	0
TaskInvalidReason	string	The reason why the task stopped running: PullStreamFailed: An exception occurred while pulling the source stream. A retry is in progress. PushStreamFailed: An exception occurred during stream ingest. A retry is in progress. UnknownError: An unknown error occurred. Note This parameter is returned only when the task is stopped.	PullStreamFailed
TaskExitTime	integer	The time when the task exited. The value is a UNIX timestamp in seconds. Note This parameter is returned only when the task has exited.	1726354625
TaskExitReason	string	The reason why the task exited: TriggerByUser: The task was manually stopped. OverEndTime: The preset end time was reached. Note This parameter is returned only when the task has exited.	TriggerByUser
CurrentOffset	integer	The current playback offset in seconds.	0
CurrentFileIndex	integer	The index of the current file in the playlist.	0
TaskInfo	object	The task information.
TaskId	string	The task ID.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskName	string	The task name.	taskname
StartTime	string	The start time of the task. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2024-12-04T09:16:00Z
EndTime	string	The end time of the task. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2024-12-30T14:30:00Z
SourceType	string	The type of the source stream. Valid values: live: a live stream. vod: an ApsaraVideo VOD resource. url: a third-party video file resource.	vod
SourceProtocol	string	The protocol of the source stream.	flv
SourceUrls	array	The source stream URLs.
	string	The source stream URL.	rtmp://118.178.**.5:**/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*****
DstUrl	string	The destination ingest URL.	rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******
CallbackURL	string	The HTTP webhook address.	hahaha.com
Offset	integer	The start offset of the video file in seconds. The value must be greater than 0. Note This indicates the time offset relative to the first frame from which to start reading. This parameter is valid only for ApsaraVideo VOD resources or video files.	0
FileIndex	integer	The index of the file from which to start playback.	0
RetryCount	integer	The number of retries.	3
RetryInterval	integer	The retry interval in seconds.	60
RepeatNumber	integer	The number of times to repeat the playback after it is complete. Valid values: 0 (default): The playback is not repeated. -1: The playback is repeated in a loop. A positive integer: The number of times to repeat the playback. Note This parameter is valid only for ApsaraVideo VOD or third-party video streams.	0

Examples

Success response

JSON format

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245*****",
  "Total": 3,
  "PageNumber": 1,
  "PageSize": 10,
  "TaskList": [
    {
      "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
      "TaskStatus": 0,
      "TaskInvalidReason": "PullStreamFailed",
      "TaskExitTime": 1726354625,
      "TaskExitReason": "TriggerByUser",
      "CurrentOffset": 0,
      "CurrentFileIndex": 0,
      "TaskInfo": {
        "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
        "TaskName": "taskname",
        "StartTime": "2024-12-04T09:16:00Z",
        "EndTime": "2024-12-30T14:30:00Z",
        "SourceType": "vod",
        "SourceProtocol": "flv",
        "SourceUrls": [
          "rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******"
        ],
        "DstUrl": "rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******",
        "CallbackURL": "hahaha.com",
        "Offset": 0,
        "FileIndex": 0,
        "RetryCount": 3,
        "RetryInterval": 60,
        "RepeatNumber": 0
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	LiveServiceNotFound	Your account does not open Live service yet	Your account has not yet activated ApsaraVideo Live.
400	CodeInvalidAliUid	This aliuid does not have a live domain name.	This aluid does not have a live domain name.
500	InternalError	%s.	error on the live liveapi server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.