保利威文档中心

幫助中心

查詢影片同步任務

更新時間:2025-01-14 15:45:08

介面描述

1、分页查询账号下的视频同步任务详情
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/video/grab/{userid}/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名 必填 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
page false Integer 頁數,預設為1
pageSize false Integer 每頁筆數,預設為10

範例

http://api.polyv.net/v2/video/grab/1b448be323/list?sign=B2F7F749B86C93514BDA9E56902B38D1514D0F9E&pageSize=2&page=1&ptime=1617154745507

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回同步任務資訊【詳見Data欄位說明】,回應失敗時返回空
Data參數說明
欄位 類型 說明
pageNumber Integer 目前的頁數
totalItems Integer 總筆數
contents Array 查詢的結果列表【詳見Contents欄位說明
firstPage Boolean 是否為第一頁,值為:true/false
lastPage Boolean 是否為最後一頁,值為:true/false
nextPageNumber Integer 下一頁編號
prePageNumber Integer 上一頁編號
totalPages Integer 總頁數
startRow Integer 當前頁第一筆記錄在總同步記錄中的位置
endRow Integer 當前頁最後一筆記錄在總同步記錄中的位置
limit Integer 當前頁同步任務記錄筆數
offset Integer 分頁起始記錄
Contents參數說明
欄位 類型 說明
taskid String 同步任務對應的id
userid String 保利威點播帳戶id
originalname String 上傳的同步任務csv檔案標題
fileurl String 同步任務的csv檔案位址
classifyid Integer 上傳到點播的分類id
classifyname String 分類名稱
seccesscount Integer 同步任務成功的數量
totalcount Integer 此任務內總同步數
failcount Integer 同步任務失敗的數量
status String 同步任務狀態
Y:啟動
N:暫停
endtime Long 任務完成時間,13位毫秒級時間戳
createtime Long 任務建立時間,13位毫秒級時間戳

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoUploadTest.class);
/**
 * 查询视频同步任务
 */
@Test
public void testGetVideoSyncTask() 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/grab/%s/list",userid);
    String page = "1";
    String pageSize =  "2";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询视频同步任务详情,{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [{
            "taskid": "0mKdBQDsbR",
            "userid": "1b448be323",
            "filename": null,
            "originalname": "批量同步任务",
            "filesize": null,
            "filepath": null,
            "fileurl": "",
            "classifyid": null,
            "classifyname": null,
            "seccesscount": 2,
            "totalcount": 2,
            "failcount": 0,
            "status": "Y",
            "endtime": 1617096051000,
            "createtime": 1617095853000,
            "param1": null,
            "param2": null,
            "callbackurl": ""
        }, {
            "taskid": "QQf4rRojYq",
            "userid": "1b448be323",
            "filename": null,
            "originalname": "批量同步任务",
            "filesize": null,
            "filepath": null,
            "fileurl": "",
            "classifyid": null,
            "classifyname": null,
            "seccesscount": 1,
            "totalcount": 1,
            "failcount": 0,
            "status": "Y",
            "endtime": 1617093860000,
            "createtime": 1617093668000,
            "param1": null,
            "param2": null,
            "callbackurl": ""
        }],
        "lastPage": true,
        "firstPage": true,
        "startRow": 1,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "totalPages": 1,
        "endRow": 2,
        "limit": 2,
        "offset": 0
    }
} 

異常範例

{
  "code":400,
  "status":"error",
  "message":"TaskId is null!",
  "data":""
}
联系客服,在线咨询