DescribeLivePullToPushList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Performs a fuzzy query on pulled-stream relay tasks based on the task ID, task name, or destination URL. Pagination is supported.

Operation description

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you consider this limit when calling this operation.

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 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 support 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 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. For more information, see Common condition keys.
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
Region	string	Yes	The region of the live center. Valid values: ap-southeast-1: Singapore ap-southeast-5: Indonesia (Jakarta) cn-beijing: China (Beijing) cn-shanghai: China (Shanghai)	cn-shanghai
TaskId	string	No	Fuzzy search is performed based on the specified task ID. The ID can be up to 55 characters in length and can contain letters, digits, underscores (_), and hyphens (-).	861009
TaskName	string	No	Fuzzy search is performed based on the specified task name.	task
DstUrl	string	No	Fuzzy search is performed based on the specified destination URL.	rtmp://qd
PageNumber	integer	No	The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: [1,100].	10

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	a05e6b15-15af-405b-a4a2-0152245*****
Total	integer	The total number of entries returned.	3
PageNumber	integer	The number of the page.	1
PageSize	integer	The number of entries per page.	10
TaskList	array	The tasks.
	object	The information about the tasks returned.
TaskId	string	The task ID.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatus	integer	The task status. Valid values: 0: not started. 1: running. Stream pulling and stream relay are normal. 2: abnormal. 3: stopped. It may be because exceptions occur during stream pulling or stream relay or you proactively call the StopLivePullToPush operation. -1: exited.	0
TaskInvalidReason	string	The reason why the task is interrupted. Valid values: PullStreamFailed: An exception occurred while pulling the source stream. A retry is in progress. PushStreamFailed: An exception occurred while pushing the stream. A retry is in progress. UnknownError: An unknown exception occurred. Note This parameter is returned only if the task is interrupted.	PullStreamFailed
TaskExitTime	integer	The time when the task was exited. The value is a Unix timestamp in seconds. Note This parameter is returned only if the task is exited.	1726354625
TaskExitReason	string	The reason why the task was exited. Valid values: TriggerByUser: You proactively stopped the task. OverEndTime: The specified end time was exceeded. Note This parameter is returned only if the task is exited.	TriggerByUser
CurrentOffset	integer	The current offset for video playback.	0
CurrentFileIndex	integer	The current file index.	0
TaskInfo	object	The information about the task.
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 follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-12-04T09:16:00Z
EndTime	string	The end time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-12-30T14:30:00Z
SourceType	string	The type of the source stream. Valid values: live: a live stream vod: a list of ApsaraVideo VOD resources url: a list of video resources from a third party	vod
SourceProtocol	string	The protocol of the source stream.	flv
SourceUrls	array	The source URLs.
	string	The source URL of the stream.	rtmp://118.178.**.5:**/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*****
DstUrl	string	The destination URL to which the stream is relayed.	rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******
CallbackURL	string	The HTTP callback URL.	hahaha.com
Offset	integer	The offset of the position where the system starts to read the video resource. Unit: seconds. Valid values: positive numbers. Note This parameter indicates an offset from the first frame. This parameter is applicable to only video resources from ApsaraVideo VOD or a third party.	0
FileIndex	integer	The file index, which specifies the sequence of the file where the playback starts.	0
RetryCount	integer	The number of retries.	3
RetryInterval	integer	The retry interval. Unit: seconds.	60
RepeatNumber	integer	The number of times the video list repeats after the first playback is complete. Valid values: 0 (default): specifies that the video list is played only once. -1: specifies that the video list is played in loop mode. Positive integer: specifies the number of times the video list repeats after the first playback is complete. Note This parameter is applicable to only video resources from ApsaraVideo VOD or a third party.	0

Examples

Successful 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.