查詢分類目錄的空間佔用

更新時間：2022-09-02 18:08:07

介面描述

1、通过分类id查询分类目录的空间占用情况
2、接口支持https协议

介面URL

http://api.polyv.net/v2/cata/size

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
userid	true	String	保利威點播帳戶id，可參考【取得密鑰】取得，取得路徑：官網->登入->點播（API介面）
ptime	true	Long	目前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey密鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
cataid	true	String	目錄分類id，預設為1，表示預設分類

範例

http://api.polyv.net/v2/cata/size?sign=75FA8B9593C80D848A645680C2464E3181C379B9&cataid=1&userId=1b448be323&ptime=1617849301530&userid=1b448be323

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Long	回應成功時回傳分類目錄下的佔用空間大小，單位：位元組

回傳錯誤代碼列表

code	message	說明
400	userid is blank.	使用者名稱為空
400	Could not find user by userid.	使用者id不存在
400	the sign is not right.	加密串錯誤
400	cataid不存在.	cataid不存在
400	cataid格式不正確.	cataid不是純數字
500	取得失敗.	後台發生錯誤異常
200	success	查詢成功

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询分类目录的空间占用
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetCategorySpaceUsage() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/cata/size";
    String cataid = "1602300731843";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("cataid", cataid);
    requestMap.put("userid", userId);
    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":474409450
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}