查询账号的空间流量使用

接口描述

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

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
userid	true	String	保利威点播账户id，可以参考【获取密匙】获取，获取路径：官网->登录->点播（API接口）
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&userId=1b448be323&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("userId", userId);
    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":"[e-mail]"
    }
}

异常示例

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