從回收站還原影片
更新時間:2025-01-14 15:18:04
介面描述
1、通过视频id恢复回收站中的视频到视频列表,支持批量恢复,一次性最多支持恢复100个视频
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
介面URL
http://api.polyv.net/v2/video/{userid}/recover-videos
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| ptime | true | Long | 當前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| vids | true | String | 影片id,多個影片以英文逗號分隔,一次最多提交100個 |
範例
http://api.polyv.net/v2/video/1b448be323/recover-videos
表單參數:
vids=1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1&sign=B72906295FF92E1A07338DBB5BEBEDFD69BD4EE6&ptime=1617154178480
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 成功和失敗都返回空 |
返回錯誤代碼列表
| 錯誤代碼 | message | 說明 |
|---|---|---|
| 400 | sign can not be empty. | 加密串為空 |
| 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 | vids can't be empty | 影片vid為空 |
| 400 | vids limits 100 | vids數量超過100個 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
* 从回收站恢复视频
*/
@Test
public void testRecoverVideo() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v2/video/"+userId+"/recover-videos";
String vids = "1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userId", userId);
requestMap.put("ptime", ptime);
requestMap.put("vids", vids);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFormBody(url, requestMap);
log.debug("测试从回收站恢复视频,{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "success",
"data": ""
}
異常範例
簽名不正確
{
"code":400,
"status":"error",
"message":"the sign is not right",
"data":""
}
時間戳過期
{
"code":400,
"status":"error",
"message":"ptime is too old.",
"data":""
}
影片vids為空
{
"code":400,
"status":"error",
"message":"vids can't be empty",
"data":""
}
vids數量超過100個
{
"code":400,
"status":"error",
"message":"vids limits 100",
"data":""
}
