查詢截圖任務狀態

更新時間：2025-01-14 16:06:19

介面描述

1、通过任务id获取截图任务的状态
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/video/snapshot/{userid}/getTaskStatus

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
taskId	true	String	任務id【可透過在影片指定時間點截圖取得】

範例

http://api.polyv.net/v2/video/snapshot/1b448be323/getTaskStatus?sign=67B7C378A673CE9742A45FD362DB2F68A173E39C&ptime=1617702097746&taskId=2036

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	截圖任務詳細狀態【詳見data欄位說明】

data參數說明

欄位	類型	說明
taskId	Integer	任務id
userId	String	保利威點播帳戶id，可參考【取得密鑰】取得，取得路徑：官網->登入->點播（API介面）
vid	String	影片id
status	String	任務狀態 waiting：等待截圖 processing：截圖處理中 success：任務成功 fail：任務失敗
createTime	Integer	任務建立時間，13位毫秒級時間戳
beginProcessTime	Integer	開始截圖的時間，13位毫秒級時間戳，任務未開始為0
finishProcessTime	Integer	完成截圖的時間，13位毫秒級時間戳，任務未完成為0
snapshots	Array	截圖資訊陣列，任務失敗或未開始時為空陣列【詳見snapshots參數說明】

snapshots參數說明

欄位	類型	說明
offsetTime	Integer	截圖時間點
imageUrl	String	截圖的url位址

返回錯誤代碼列表

錯誤代碼	message	說明
400	sign can not be empty.	加密串為空
400	vid invalid.	影片vid錯誤
400	ptime is too old.	時間戳過期
400	ptime is illegal.	時間戳參數格式不對或超過當前時間3分鐘
400	Could not find user by userid.	userid不存在
400	the sign is not right.	加密串不正確
400	task not found	任務不存在

Java請求範例

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

強烈建議您使用點播Java SDK完成API的功能對接，點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(VodSnapshotTest.class);
/**
 * 获取截图任务状态
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetSnapshotTask() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/snapshot/%s/getTaskStatus", userId);
    String taskId = "2036";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("taskId", taskId);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试获取截图任务状态,{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "taskId": 2036,
        "userId": "1b448be323",
        "vid": "1b448be32303e4922a8f70d6b48220ae_1",
        "status": "success",
        "createTime": 1617700207000,
        "beginProcessTime": 1617700208000,
        "finishProcessTime": 1617700260000,
        "snapshots": [
            {
                "offsetTime": 5,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/5.jpg"
            },
            {
                "offsetTime": 10,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/10.jpg"
            },
            {
                "offsetTime": 15,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/15.jpg"
            },
            {
                "offsetTime": 20,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/20.jpg"
            }
        ]
    }
}

異常範例

任務不存在

{
    "code": 400,
    "status": "error",
    "message": "task not found",
    "data": ""
}