Unlock the Power of AI

1 million free tokens

88% Price Reduction

Activate Now

DescribeLivePullToPushList

Updated at: 2025-03-26 03:49

Queries pulled-stream relay tasks. Fuzzy match is supported.

Operation description

Usage notes

  • You can call this operation to query pulled-stream relay tasks.
  • You can query tasks by page. Fuzzy search is supported based on task IDs, task names, and destination URLs.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLivePullToPushListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
RegionstringYes

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)

Enumerated values:

  • ap-northeast-1
  • ap-southeast-1
  • ap-southeast-5
  • eu-central-1
  • me-central-1
  • cn-beijing
  • cn-shanghai
  • cn-shenzhen
  • cn-qingdao
  • preregion
cn-shanghai
TaskIdstringNo

The task ID. Fuzzy search is performed based on the task ID.

Note
The ID can be up to 55 characters in length and can contain letters, digits, underscores (_), and hyphens (-).
861009
TaskNamestringNo

The task name. Fuzzy search is performed based on the task name.

task
DstUrlstringNo

The destination URL. Fuzzy search is performed based on the destination URL.

rtmp://qd
PageNumberintegerNo

The page number.

Note
The value must be greater than 0 and not greater than the maximum value of the Integer data type. Default value: 1.
1
PageSizeintegerNo

The number of entries per page.

Note
Valid values: [1,100]. Default value: 10.
10

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

a05e6b15-15af-405b-a4a2-0152245*****
Totalinteger

The total number of entries returned.

3
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TaskListarray<object>

The tasks.

TaskListobject

The information about the tasks returned.

TaskIdstring

The task ID.

fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskStatusinteger

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
TaskInvalidReasonstring

The reason why the task was stopped.

  • PullStreamFailed: An exception occurred while pulling the source stream. A retry is in progress.
  • PushStreamFailed: An exception occurred while ingesting the stream. A retry is in progress.
  • UnknownError: An unknown exception occurred.
Note
This parameter is returned only if the task status is stopped.
PullStreamFailed
TaskExitTimeinteger

The time when the task was exited. The value is a Unix timestamp in seconds.

Note
This parameter is returned only if the task status is exited.
1726354625
TaskExitReasonstring

The reason why the task was exited. Valid values:

  • TriggerByUser: You proactively ended the task.
  • OverEndTime: The specified end time was exceeded.
Note
This parameter is returned only if the task status is exited.
TriggerByUser
CurrentOffsetinteger

The current offset for video playback.

0
CurrentFileIndexinteger

The current file index.

0
TaskInfoobject

The information about the task.

TaskIdstring

The task ID.

fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
TaskNamestring

The task name.

taskname
StartTimestring

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
EndTimestring

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
SourceTypestring

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
SourceProtocolstring

The protocol of the source stream.

flv
SourceUrlsarray

The source URLs.

sourceUrlsstring

The source URL of the stream.

rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******
DstUrlstring

The destination URL to which the stream is relayed.

rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******
CallbackURLstring

The HTTP callback URL.

hahaha.com
Offsetinteger

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
FileIndexinteger

The file index, which indicates the sequence of the file where the playback starts.

0
RetryCountinteger

The number of retries allowed.

3
RetryIntervalinteger

The retry interval. Unit: seconds.

60

Examples

Sample success responses

JSONformat

{
  "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
      }
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400InvalidParameter%s.Parameter error
400LiveServiceNotFoundYour account does not open Live service yetYour account has not yet activated ApsaraVideo Live.
500InternalError%s.error on the live liveapi server.

For a list of error codes, visit the Service error codes.

Previous:NoneNext: ApsaraVideo Live
  • On this page (1)
  • Operation description
  • Usage notes
  • QPS limit
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare