查詢直播截圖任務
更新時間 2023-12-27 14:30:23
最近更新時間: 2023-12-27 14:30:23
分享文章
- 請求方式：
get - 請求路徑：
/live/snapshot/query-snapshot
請求參數說明
| 參數名 | 類型 | 名稱 | 是否必填 | 說明 |
|---|---|---|---|---|
| TaskID | string | 任務ID | 是 | 任務ID，對應任務創建時返回的ID，目前只支持單個任務 |
返回參數說明
| 參數名 | 類型 | 名稱 |
|---|---|---|
| code | int | 狀態碼，成功時為100000 |
| message | string | 描述信息，成功時為success |
| TaskList | list | 任務信息列表，目前只支持返回單個任務信息,詳細說明如下 |
| TaskList[*].TaskID | string | 任務ID |
| TaskList[*].TaskType | string | 任務類型，含義分別為： live-record：直播錄制 live-snapshot：直播截圖 live-ext-redirect：直播轉推 |
| TaskList[*].UniqName | string | 客戶標識 |
| TaskList[*].DomainName | string | 域名 |
| TaskList[*].App | string | 頻道名 |
| TaskList[*].Stream | string | 流名稱 |
| TaskList[*].Params | object | 轉碼參數，當taskType等于live-record或live-snapshot時存在 |
| TaskList[*].Params.Output | object array | 輸出參數 |
| TaskList[].Params.Output[].Format | string | 輸出圖片的封裝格式 |
| TaskList[].Params.Output[].Interval | string | 截圖間隔時長，單位秒 |
| TaskList[*].Params.XOSAccessKey | string | XOS存儲的訪問密鑰 |
| TaskList[*].Params.XOSSecretKey | string | XOS存儲的訪問密鑰 |
| TaskList[*].Params.XOSBucket | string | XOS存儲的Bucket名稱 |
| TaskList[*].Params.XOSRegion | string | XOS存儲的Region名稱 |
| TaskList[*].Params.SnapshotNotifyUrl | string | 截圖文件回調通知URL |
| TaskList[*].CreateTime | string | 任務創建時間，格式yyyy-MM-dd HH:mm:ss |
| TaskList[*].UpdateTime | string | 任務更新時間，格式yyyy-MM-dd HH:mm:ss |
| TaskList[*].TaskStatus | string | 任務執行狀態，有三種，分別是 “running” ：任務運行中 “finished” ：任務正常結束 “failed” ：任務失敗 |
| TaskList[*].ErrMsg | string | 任務具體錯誤信息 |
調用示例
//cdnapi-global.ctapi.daliqc.cn/live/snapshot/query-snapshot
返回結果：
{
"code":100000,
"TaskList":[
{
"App":"test",
"TaskID":"123",
"DomainName":"daliqc.cn",
"ErrMsg":"Task scheduling exception",
"CreateTime":"2022-02-24 14:57:43",
"Params":{
"OssAccessKey":"test",
"Output":[
{
"Format":"jpg",
"Interval":"10"
}
],
"SnapshotNotifyUrl":"test",
"OssBucket":"test",
"OssSecretKey":"test",
"OssRegion":"test"
},
"TaskStatus":"failed",
"Template":"None",
"Referrer":"open-api",
"UniqName":"123",
"TaskType":"live-snapshot",
"UpdateTime":"2022-02-24 14:57:43",
"Worker":"unknown",
"Stream":"test",
"SrcUrl":"None",
"DstUrl":""
}
],
"message":"success"
}
