模糊查詢拉流轉推任務。
介面說明
調用本介面查詢拉流轉推工作清單。
支援分頁查詢工作清單,支援以任務 ID、任務名稱和目標推流地址進行模糊搜尋。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLivePullToPushList |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| Region |
string |
是 |
指定直播中心查詢。取值:
|
cn-shanghai |
| TaskId |
string |
否 |
任務 ID,根據任務 ID 模糊搜尋。 說明
任務 ID 由大小寫字母、數字、底線、短劃線(-)組成,最大 55 字元。 |
861009 |
| TaskName |
string |
否 |
任務名稱,根據任務名稱模糊搜尋。 |
task |
| DstUrl |
string |
否 |
目標推流地址,根據目標推流地址模糊搜尋。 |
rtmp://qd |
| PageNumber |
integer |
否 |
頁碼。 說明
該參數取值大於 0 且不超過 整數資料類型的最大值,預設值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁可展示的記錄數。 說明
預設值為 10,取值範圍[1,100]。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 id。 |
a05e6b15-15af-405b-a4a2-0152245***** |
| Total |
integer |
查詢結果總數。 |
3 |
| PageNumber |
integer |
分頁頁數。 |
1 |
| PageSize |
integer |
每頁的查詢記錄數。 |
10 |
| TaskList |
array<object> |
任務資訊列表。 |
|
|
array<object> |
任務資訊列表 |
||
| TaskId |
string |
任務 ID。 |
fb0d4ac7-c7e3-4978-9743-0bf2f6e8**** |
| TaskStatus |
integer |
任務目前狀態:
|
0 |
| TaskInvalidReason |
string |
任務停止運行原因:
說明
僅停止運行狀態下返回。 |
PullStreamFailed |
| TaskExitTime |
integer |
任務退出時間,Unix 秒級時間戳記。 說明
僅已退出狀態下返回。 |
1726354625 |
| TaskExitReason |
string |
任務退出原因:
說明
僅已退出狀態下返回。 |
TriggerByUser |
| CurrentOffset |
integer |
當前生效的視頻播放位移。 |
0 |
| CurrentFileIndex |
integer |
當前生效的節目單序列位移。 |
0 |
| TaskInfo |
object |
任務資訊。 |
|
| TaskId |
string |
任務 ID。 |
fb0d4ac7-c7e3-4978-9743-0bf2f6e8**** |
| TaskName |
string |
任務名稱。 |
taskname |
| StartTime |
string |
任務開始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2024-12-04T09:16:00Z |
| EndTime |
string |
任務結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2024-12-30T14:30:00Z |
| SourceType |
string |
源流類型,枚舉值:
|
vod |
| SourceProtocol |
string |
源流協議名。 |
flv |
| SourceUrls |
array |
源流 URL 地址。 |
|
|
string |
源流 URL 地址。 |
rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun******* |
|
| DstUrl |
string |
推流目標地址。 |
rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_******* |
| CallbackURL |
string |
HTTP 回調地址。 |
hahaha.com |
| Offset |
integer |
啟動位移,視頻檔案起始位移值。單位:秒。取值:大於 0。 說明
|
0 |
| FileIndex |
integer |
檔案索引,從第 n 個檔案開始播放起。 |
0 |
| RetryCount |
integer |
重試次數。 |
3 |
| RetryInterval |
integer |
稍候再試,單位秒。 |
60 |
| RepeatNumber |
integer |
播放完後重複繼續播放的次數。取值:
說明
此參數僅針對點播或第三方視頻流。 |
0 |
樣本
正常返回樣本
JSON格式
{
"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
}
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s. | 參數錯誤 |
| 400 | LiveServiceNotFound | Your account does not open Live service yet | 您的賬戶尚未開通直播服務 |
| 400 | CodeInvalidAliUid | This aliuid does not have a live domain name. | 這個aluid沒有直播網域名稱 |
| 500 | InternalError | %s. | 直播 liveapi 服務端錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。