Documentation
Home Page ApsaraVideo Live Developer Reference API Reference API catalog Pulled-stream relay DescribeLivePullToPush

DescribeLivePullToPush

Updated at:
Copy as MD
Product

Calls DescribeLivePullToPush to query a pull-to-push streaming task.

Operation description

  • Call this API operation to query a pull-to-push streaming task.

  • Supports querying the configuration information and status information of a task with a specified ID.

QPS Limit

The single-user QPS limit for this API is 10 calls per second. Exceeding the limit will result in API throttling, which may affect your business. Please call this API appropriately.

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:DescribeLivePullToPush

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

No

The region ID.

cn-shanghai
TaskId

string

Yes

The task ID.

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

string

Yes

The region where the task is launched. Valid values:

  • ap-southeast-1 (Singapore)

  • ap-southeast-5 (Indonesia)

  • cn-beijing (Beijing)

  • cn-shanghai (Shanghai)

Valid values:

  • cn-shenzhen :

    Shenzhen

  • cn-qingdao :

    Qingdao

  • preregion :

    Pre-release

  • cn-beijing :

    Beijing

  • cn-shanghai :

    Shanghai

  • ap-southeast-1 :

    Singapore

  • eu-central-1 :

    Germany (Frankfurt)

  • ap-northeast-1 :

    Japan (Tokyo)

  • ap-southeast-5 :

    Indonesia

  • me-central-1 :

    Saudi Arabia (Riyadh)

cn-shanghai

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

a05e6b15-15af-405b-a4a2-0152245d****
RetCode

integer

The return code.

Note

  • "0" is returned under normal circumstances.

  • For abnormal cases, refer to the error code list below.

0
Description

string

The error description.

OK
TaskId

string

The newly created task ID.

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

integer

The current task status:

  • 0: Not started (the start time has not been reached).

  • 1: Running normally (pull streaming and push streaming are normal).

  • 2: Running abnormally.

  • 3: Stopped (pull streaming or push streaming is abnormal, or the task was actively stopped by calling the API).

  • -1: Exited.

0
TaskInvalidReason

string

The reason why the task stopped running:

  • PullStreamFailed: Source stream pull exception, retrying.

  • PushStreamFailed: Destination stream push exception, retrying.

  • UnknownError: Unknown exception.

Note

Only returned when the task is in stopped state.

PullStreamFailed
TaskExitTime

integer

The task exit time, in Unix seconds timestamp.

Note

Only returned when the task is in exited state.

1726354625
TaskExitReason

string

The reason for task exit:

  • TriggerByUser: Actively ended by the user.

  • OverEndTime: Exceeded the preset end time.

Note

Only returned when the task is in exited state.

TriggerByUser
CurrentOffset

integer

The currently effective video playback offset.

0
CurrentFileIndex

integer

The currently effective playlist sequence offset.

0
TaskInfo

object

The task information.

TaskId

string

The task ID.

fd245384-4067-4f91-9d75-9666a6bc9****
TaskName

string

The task name.

test
StartTime

string

The task start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

2024-08-26T10:30:00Z
EndTime

string

The task end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).

2024-08-27T14:30:00Z
SourceType

string

The source stream type. Valid values:

  • live: Live stream.

  • vod: Alibaba Cloud VOD resource.

  • url: Third-party video file resource.

vod
SourceProtocol

string

The source stream protocol name.

RTMP
SourceUrls

array

The source stream URL addresses.

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434

string

The source stream URL address.

rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
DstUrl

string

The push stream destination address.

rtmp://pushtest.********.aliyunlive.com/pulltest493/pulltest-w434
CallbackURL

string

The HTTP callback URL.

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

integer

The start offset, which is the starting offset value for the video file. Unit: seconds. Value: greater than 0.

Note

  • Indicates starting to read from a position offset relative to the first frame.

  • Only valid for VOD resources or video files.

0
FileIndex

integer

The file index, starting playback from the nth file.

0
RetryCount

integer

The number of retries.

3
RetryInterval

integer

The retry interval, in seconds.

60
RepeatNumber

integer

The number of times to repeat playback after completion. Valid values:

  • 0 (default): No repeat playback.

  • -1: Loop indefinitely.

  • Other positive integers: The number of times to repeat playback after completion.

Note

This parameter only applies to VOD or third-party video streams.

0

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter %s. Parameter error
400 CodeInvalidAliUid This aliuid does not have a live domain name. This aluid does not have a live domain name.
400 CodeTaskNotExist Task does not exist. The task does not exist.
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.

Previous：DeleteLivePullToPushNext：DescribeLivePullToPushList