> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/vod/api/video-upload/get_video_sync_task.md).
# 查询视频同步任务
### 接口描述
```
1、分页查询账号下的视频同步任务详情
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
```
### 接口URL
```
http://api.polyv.net/v2/video/grab/{userid}/list
```
[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/video/grab/%7Buserid%7D/list/README.md)
### 请求方式
```
GET
```
### 接口约束
1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)
### 请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
| -------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userid | true | String | 保利威点播账户id，可以参考【[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口） |
| ptime | true | Long | 当前时间的毫秒级时间戳，3分钟内有效 |
| sign | true | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】 |
| page | false | Integer | 页数，默认为1 |
| pageSize | false | Integer | 每页数目，默认为10 |
### 示例
```requestUrl
http://api.polyv.net/v2/video/grab/1b448be323/list?sign=B2F7F749B86C93514BDA9E56902B38D1514D0F9E&pageSize=2&page=1&ptime=1617154745507
```
### 响应参数描述
| 参数名 | 类型 | 说明 |
| ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息，当code为400或者500的时候，辅助描述错误原因 |
| data | Object | 响应成功时返回同步任务信息【详见[Data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_upload/get_video_sync_task.md?id=polyv1)】，响应失败时返回空 |
[**Data参数描述**](#/vod/api/video_upload/get_video_sync_task.md?id=polyv1)
| 字段 | 类型 | 说明 |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| pageNumber | Integer | 当前的页数 |
| totalItems | Integer | 总的条数 |
| contents | Array | 查询的结果列表【详见[Contents字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_upload/get_video_sync_task.md?id=polyv2)】 |
| firstPage | Boolean | 是否为第一页，值为：true/false |
| lastPage | Boolean | 是否为最后一页，值为：true/false |
| nextPageNumber | Integer | 下一页编号 |
| prePageNumber | Integer | 上一页编号 |
| totalPages | Integer | 总页数 |
| startRow | Integer | 当前页第一条记录在总同步记录中的位置 |
| endRow | Integer | 当前页最后一条记录在总同步记录中的位置 |
| limit | Integer | 当前页同步任务记录个数 |
| offset | Integer | 分页起始记录 |
[**Contents参数描述**](#/vod/api/video_upload/get_video_sync_task.md?id=polyv2)
| 字段 | 类型 | 说明 |
| ------------ | ------- | ----------------------------- |
| taskid | String | 同步任务对应的id |
| userid | String | 保利威点播账户id |
| originalname | String | 上传的同步任务csv文件的标题 |
| fileurl | String | 同步任务的csv文件地址 |
| classifyid | Integer | 上传到点播的分类id |
| classifyname | String | 分类名称 |
| seccesscount | Integer | 同步任务成功的数量 |
| totalcount | Integer | 此任务内总同步数 |
| failcount | Integer | 同步任务失败的数量 |
| status | String | 同步任务状态
Y：启动
N：暂停
|
| endtime | Long | 任务完成时间，13位毫秒级时间戳 |
| createtime | Long | 任务创建时间，13位毫秒级时间戳 |
### Java请求示例
快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。
> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
```java
private static final Logger log = LoggerFactory.getLogger(VodVideoUploadTest.class);
/**
* 查询视频同步任务
*/
@Test
public void testGetVideoSyncTask() 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/grab/%s/list",userid);
String page = "1";
String pageSize = "2";
Map requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("page", page);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试查询视频同步任务详情,{}", response);
//do somethings
}
```
### 响应示例
系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)
成功示例
```json
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageNumber": 1,
"totalItems": 2,
"contents": [{
"taskid": "0mKdBQDsbR",
"userid": "1b448be323",
"filename": null,
"originalname": "批量同步任务",
"filesize": null,
"filepath": null,
"fileurl": "",
"classifyid": null,
"classifyname": null,
"seccesscount": 2,
"totalcount": 2,
"failcount": 0,
"status": "Y",
"endtime": 1617096051000,
"createtime": 1617095853000,
"param1": null,
"param2": null,
"callbackurl": ""
}, {
"taskid": "QQf4rRojYq",
"userid": "1b448be323",
"filename": null,
"originalname": "批量同步任务",
"filesize": null,
"filepath": null,
"fileurl": "",
"classifyid": null,
"classifyname": null,
"seccesscount": 1,
"totalcount": 1,
"failcount": 0,
"status": "Y",
"endtime": 1617093860000,
"createtime": 1617093668000,
"param1": null,
"param2": null,
"callbackurl": ""
}],
"lastPage": true,
"firstPage": true,
"startRow": 1,
"nextPageNumber": 1,
"prePageNumber": 1,
"totalPages": 1,
"endRow": 2,
"limit": 2,
"offset": 0
}
}
```
异常示例
```json
{
"code":400,
"status":"error",
"message":"TaskId is null!",
"data":""
}
```