保利威文档中心

帮助中心

点播服务器 API

查询用户空间及流量情况

更新时间：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": ""
}
联系客服，在线咨询