接口URL
http://api.polyv.net/v2/video/grab/{userid}/list
接口说明
(接口调用有频率限制,详细请查看)
分页获取抓取任务列表
返回结果支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
ptime | true | string | 当前13位毫秒级时间戳,3分钟内有效 |
sign | true | string | 签名,40位大写的sha1值 |
page | true | int | 页数,默认为1 |
pageSize | true | int | 每页数目,默认为10 |
JSON示例
{
code: 200,
status: "success",
message: "",
data: {
pageNumber: 1,
totalItems: 1,
contents: [
{
taskid: "hHepZ2SjlE",
userid: "8205ac89d3",
filename: null,
originalname: "111.csv",
filesize: null,
filepath: null,
fileurl: "http://grab.polyv.net/files/csv/1522286666296.csv",
classifyid: "1",
classifyname: "视频分类(根目录)",
seccesscount: 2,
totalcount: 2,
failcount: 0,
status: "Y",
endtime: 1522286706000,
createtime: 1522286672000
}
],
startRow: 1,
endRow: 1,
firstPage: true,
lastPage: true,
nextPageNumber: 1,
prePageNumber: 1,
totalPages: 1,
limit: 1,
offset: 0
}
}
返回错误json
{
"code":400,
"status":"error",
"message":"TaskId is null!",
"data":""
}
字段说明
字段 | 说明 |
---|---|
code | 返回码 |
status | 返回状态 |
message | 返回信息 |
data | 响应结果集 |
pageNumber | 当前的页数 |
totalItems | 总的条数 |
contents | 查询的结果列表 |
taskid | 抓取任务对应的ID |
userid | 点播用户的ID |
originalname | 上传的抓取任务csv文件的标题 |
fileurl | 抓取任务的csv文件地址 |
classifyid | 上传到点播的分类ID |
classifyname | 分类名称 |
seccesscount | 抓取成功的数量 |
totalcount | 此任务内总抓取数 |
failcount | 抓取失败的数量 |
status | 抓取任务状态,Y:'启动',N: '暂停' |
endtime | 任务完成时间 |
createtime | 任务创建时间 |
firstPage | 是否为第一页,值为:true/false |
lastPage | 是否为最后一页,值为:true/false |
nextPageNumber | 下一页编号 |
prePageNumber | 上一页编号 |
totalPages | 总页数 |
startRow | 当前页第一条记录在总抓取记录中的位置 |
endRow | 当前页最后一条记录在总抓取记录中的位置 |
limit | 当前页抓取任务记录个数 |
PHP示例代码
<?php
$userid="8205ac89d3";
$secretkey = "kXmHMLeX6M";
$ptime=time()*1000;
$page=1;
$str= "page=$page&ptime=$ptime".$secretkey;
$sign=strtoupper(sha1($str));
$url="http://api.polyv.net/v2/video/grab/$userid/list?ptime=$ptime&sign=$sign&page=$page";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "GET");
$output = curl_exec($ch);
curl_close($ch);
print_r($output);
?>
签名规则:
将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:
1、请求参数为
"page" = 1;
"ptime"=1527231353000;
2、将请求参数按照参数名字典顺序排列
"page" = 1;
"ptime"=1527231353000;
3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(此处secretkey的值为kXmHMLeX6M),如下:
page=1&ptime=1527231353000kXmHMLeX6M
4、生成签名sign
生成40位大写SHA1值
1C4ADD2222714FC08584853DC22C8F66AD998BED