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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
live:DescribeLivePullToPushList | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Region | string | Yes | The region of the live center. Valid values:
Enumerated values:
| cn-shanghai |
TaskId | string | No | The task ID. Fuzzy search is performed based on the task ID.
The ID can be up to 55 characters in length and can contain letters, digits, underscores (_), and hyphens (-).
| 861009 |
TaskName | string | No | The task name. Fuzzy search is performed based on the task name. | task |
DstUrl | string | No | The destination URL. Fuzzy search is performed based on the destination URL. | rtmp://qd |
PageNumber | integer | No | The page number.
The value must be greater than 0 and not greater than the maximum value of the Integer data type. Default value: 1.
| 1 |
PageSize | integer | No | The number of entries per page.
Valid values: [1,100]. Default value: 10.
| 10 |
Response parameters
Examples
Sample success responses
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
}
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|
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. |
500 | InternalError | %s. | error on the live liveapi server. |
For a list of error codes, visit the Service error codes.