查询截图任务状态

更新时间：2025-01-14 16:06:19

接口描述

1、通过任务id获取截图任务的状态
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

接口URL

http://api.polyv.net/v2/video/snapshot/{userid}/getTaskStatus

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
taskId	true	String	任务id【可通过在视频指定时间点截图获取】

示例

http://api.polyv.net/v2/video/snapshot/1b448be323/getTaskStatus?sign=67B7C378A673CE9742A45FD362DB2F68A173E39C&ptime=1617702097746&taskId=2036

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	截图任务详细状态【详见data字段说明】

data参数描述

字段	类型	说明
taskId	Integer	任务id
userId	String	保利威点播账户id，可以参考【获取密匙】获取，获取路径：官网->登录->点播（API接口）
vid	String	视频id
status	String	任务状态 waiting：等待截图 processing：截图处理中 success：任务成功 fail：任务失败
createTime	Integer	任务创建时间，13位毫秒级时间戳
beginProcessTime	Integer	开始截图的时间，13位毫秒级时间戳，任务未开始为0
finishProcessTime	Integer	完成截图的时间，13位毫秒级时间戳，任务未完成为0
snapshots	Array	截图信息数组，任务失败或未开始时为空数组【详见snapshots参数描述】

snapshots参数描述

字段	类型	说明
offsetTime	Integer	截图时间点
imageUrl	String	截图的url地址

返回错误代码列表

错误代码	message	说明
400	sign can not be empty.	加密串为空
400	vid invalid.	视频vid错误
400	ptime is too old.	时间戳过期
400	ptime is illegal.	时间戳参数格式不对或者超过当前时间3分钟
400	Could not find user by userid.	userid不存在
400	the sign is not right.	加密串不正确
400	task not found	任务不存在

Java请求示例

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

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodSnapshotTest.class);
/**
 * 获取截图任务状态
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetSnapshotTask() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/snapshot/%s/getTaskStatus", userId);
    String taskId = "2036";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("taskId", taskId);
    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": {
        "taskId": 2036,
        "userId": "1b448be323",
        "vid": "1b448be32303e4922a8f70d6b48220ae_1",
        "status": "success",
        "createTime": 1617700207000,
        "beginProcessTime": 1617700208000,
        "finishProcessTime": 1617700260000,
        "snapshots": [
            {
                "offsetTime": 5,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/5.jpg"
            },
            {
                "offsetTime": 10,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/10.jpg"
            },
            {
                "offsetTime": 15,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/15.jpg"
            },
            {
                "offsetTime": 20,
                "imageUrl": "http://vod-assets.videocc.net/snapshot/1b448be323/1b448be32303e4922a8f70d6b48220ae/20.jpg"
            }
        ]
    }
}

异常示例

任务不存在

{
    "code": 400,
    "status": "error",
    "message": "task not found",
    "data": ""
}

点播服务器 API