查詢使用者空間及流量情況

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

介面說明

1、查询用户点播账户的空间及流量使用情况
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/user/{userid}/main

請求方式

GET

介面限制

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

請求參數說明

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

範例

 http://api.polyv.net/v2/user/1b448be323/main?date=2020-10-13&sign=8F0200C2C04945C5BDEE48E0CF6DCDC3598DEA16&userid=1b448be323&ptime=1617012847252

回應參數說明

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

Data參數描述

欄位	類型	說明
totalFlow	Long	使用者總流量，單位為byte
usedSpace	Long	已用空間，單位為byte
usedFlow	Long	已用流量，單位為byte
totalSpace	Long	使用者總空間，單位為byte
userId	String	POLYV使用者點播帳號ID，參考【取得金鑰】
email	String	POLYV使用者信箱

Java請求範例

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

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

  private static final Logger log = LoggerFactory.getLogger(VodAccountTest.class);
    /**
     * 点播DEMO：获取用户空间及流量情况
     */
    @Test
    public void testGetAccountSpaceFlow() throws Exception, NoSuchAlgorithmException {
    
        //公共参数,填写自己的实际参数
        String secretKey = super.secretKey;
        String userId = super.userId;
        String ptime = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/v2/user/"+userId+"/main";
        String date =  "2020-10-13";
    
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("userid", userId);
        requestMap.put("ptime", ptime);
        requestMap.put("date", date);
        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": {
        "videoCount": 32,
        "totalFlow": 21474836480,
        "usedSpace": 0,
        "usedFlow": 0,
        "totalSpace": 21474836480,
        "userId": "1b448be323",
        "email": "sdk-demo@polyv.net"
    }
}

異常範例

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