查詢帳號的空間流量使用

更新時間：2025-01-14 16:13:16

介面說明

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

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名	必選	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值【詳見簽名產生規則】
date	false	String	要查詢的日期，為空時預設查詢帳號最新方案起始日至今所有的空間及流量使用情況，格式：yyyy-MM-dd，例如：2019-11-11

範例

http://api.polyv.net/v2/user/1b448be323/main

表單參數：

date=2021-04-09&sign=1E839D5F6DEBDEE4BD8F8AA45F2F15BDBF15136D&ptime=1617954612523

回應參數說明

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

data參數說明

參數名	類型	說明
videoCount	Integer	使用者帳號下的影片個數
totalFlow	Long	使用者總流量，單位：位元組
usedSpace	Long	已用空間，單位：位元組
usedFlow	Long	已用流量，單位：位元組
totalSpace	Long	使用者總空間，單位：位元組
userId	String	保利威點播帳戶id
email	String	POLYV使用者信箱

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 testGetTotalUsage() 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="2021-04-09";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("date", date);
    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":{
        "videoCount":57,
        "totalFlow":21474836480,
        "usedSpace":41850482,
        "usedFlow":82653532,
        "totalSpace":21474836480,
        "userId":"1b448be323",
        "email":"sdk-demo@polyv.net"
    }
}

異常範例

{
    "code":400,
    "status":"error",
    "message":"sign can not be empty.",
    "data":""
}