查询视频源文件取回任务

接口描述

1、查询已提交的任务情况 2、接口支持https协议

接口URL

http://api.polyv.net/v3/video/source-file-task/get

请求方式

GET

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

保利威点播子账户appId,获取路径:保利威点播后台->设置->账号管理

timestamp

true

Long

当前时间的毫秒级时间戳,3分钟内有效

sign

true

String

签名,32位大写MD5值【详见MD5签名生成规则

taskId

true

String

任务ID【详见创建任务

示例

http://api.polyv.net/v3/video/source-file-task/get?taskId=16661c08b9564c1ea6f4544ccd568e58&expireDays=1&appId=a0Wmol5EwX&sign=197679CCF105DD80E0378BEF75993D31&timestamp=1617950661602

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

requestId

String

本次请求的业务流水号,便于客户端/服务器端排查问题

error

Object

响应失败时返回错误的详细信息【详见error字段说明】,响应成功时返回空

data

Array

响应成功时返回视频信息列表【详见data字段说明】,响应失败时返回空

error字段说明

字段类型说明

code

Integer

错误码

desc

String

错误描述【详见全局错误说明

data字段说明

字段类型说明

vid

String

视频ID

url

String

视频源文件下载链接

status

Enum

状态(INIT-初始化, PROCESS-处理中, SUCCESS-成功, FAIL-失败)

createTime

long

创建时间,毫秒级时间戳

successTime

long

处理成功时间,毫秒级时间戳

Java请求示例

快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

private static final Logger log = LoggerFactory.getLogger(Test.class);

/**
 * 查询视频源文件取回任务
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void tesGetVideoSourceFileTask() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/v3/video/source-file-task/get";
        String taskId = "16661c08b9564c1ea6f4544ccd568e58";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("taskId", taskId);

        //用md5进行签名,使用子账号的secretKey签名
        requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.debug("测试查询视频源文件取回任务,{}", response);
        //do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "requestId": "a7f2e4e3-5884-43b3-b3e7-705cdcbb66eb",
    "code": 200,
    "status": "success",
    "error": null,
    "data": [
        {
            "vid": "1b448be32370f4822ac40fd926112a66_1",
            "url": "https://video-dl-2.videocc.net/1b448be323/6/1b448be32370f4822ac40fd926112a66.mp4?auth_key=1694663401-3iwFnV2uJx-ac59aff03d-c71c8c4e01284d892c2dc9ad1ee57272",
            "status": "SUCCESS",
            "createTime": 1694663401000,
            "successTime": 1694663401000
        },
		{
            "vid": "1b448be32305bb29879b1eb06abd9fa1_1",
            "url": null,
            "status": "PROCESS",
            "createTime": 1694663401000,
            "successTime": null
        }
    ]
}

异常示例

{
    "requestId": "e7544473-250a-40eb-b53b-8768195617e0", 
    "code": 403, 
    "status": "error", 
    "error": {
        "code": 104, 
        "desc": "invalid signature"
    }, 
    "data": null
}

Last updated