查詢影片原始檔取回任務

更新時間：2023-09-14 17:29:57

介面說明

1、查詢已提交的任務狀況
2、介面支援 HTTPS 協定

介面 URL

http://api.polyv.net/v3/video/source-file-task/get

請求方式

GET

介面限制

1、介面同時支援 HTTP 與 HTTPS，建議使用 HTTPS 以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必選	類型	說明
appId	true	String	保利威點播子帳戶 appId，取得路徑：保利威點播後台 -> 設定 -> 帳號管理
timestamp	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，32位元大寫 MD5 值【詳見 MD5 簽名產生規則】
taskId	true	String	任務 ID【詳見建立任務】

範例

http://api.polyv.net/v3/video/source-file-task/get?taskId=16661c08b9564c1ea6f4544ccd568e58&expireDays=1&appId=a0Wmol5EwX&sign=197679CCF105DD80E0378BEF75993D31&timestamp=1617950661602

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200 為成功返回，非 200 為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
requestId	String	本次請求的業務流水號，便於客戶端/伺服端排查問題
error	Object	回應失敗時返回錯誤的詳細資訊【詳見 error 欄位說明】，回應成功時返回空
data	Array	回應成功時返回影片資訊列表【詳見 data 欄位說明】，回應失敗時返回空

error 欄位說明

欄位	類型	說明
code	Integer	錯誤碼
desc	String	錯誤描述【詳見全域錯誤說明】

data 欄位說明

欄位	類型	說明
vid	String	影片 ID
url	String	影片原始檔下載連結
status	Enum	狀態（INIT-初始化, PROCESS-處理中, SUCCESS-成功, FAIL-失敗）
createTime	long	建立時間，毫秒級時間戳
successTime	long	處理成功時間，毫秒級時間戳

Java 請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

private static final Logger log = LoggerFactory.getLogger(Test.class);

/**
 * 查询视频源文件取回任务
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void tesGetVideoSourceFileTask() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/v3/video/source-file-task/get";
        String taskId = "16661c08b9564c1ea6f4544ccd568e58";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("taskId", taskId);

        //用md5进行签名，使用子账号的secretKey签名
        requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.debug("测试查询视频源文件取回任务,{}", response);
        //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "requestId": "a7f2e4e3-5884-43b3-b3e7-705cdcbb66eb",
    "code": 200,
    "status": "success",
    "error": null,
    "data": [
        {
            "vid": "1b448be32370f4822ac40fd926112a66_1",
            "url": "https://video-dl-2.videocc.net/1b448be323/6/1b448be32370f4822ac40fd926112a66.mp4?auth_key=1694663401-3iwFnV2uJx-ac59aff03d-c71c8c4e01284d892c2dc9ad1ee57272",
            "status": "SUCCESS",
            "createTime": 1694663401000,
            "successTime": 1694663401000
        },
        {
            "vid": "1b448be32305bb29879b1eb06abd9fa1_1",
            "url": null,
            "status": "PROCESS",
            "createTime": 1694663401000,
            "successTime": null
        }
    ]
}

異常範例

{
    "requestId": "e7544473-250a-40eb-b53b-8768195617e0", 
    "code": 403, 
    "status": "error", 
    "error": {
        "code": 104, 
        "desc": "invalid signature"
    }, 
    "data": null
}