（→简介） |
（→简介） |
||
| 第1行： | 第1行： | ||
{{yingyan-sidebar}} | {{yingyan-sidebar}} | ||
==简介== | ==简介== | ||
| − | + | 批量导出类接口提供批量导出轨迹数据功能，该类接口将一段时间内的轨迹数据打包成文件，生成下载链接供开发者下载。该类接口包括三个 API： | |
{| border="1" cellspacing="0" cellpadding="0" | {| border="1" cellspacing="0" cellpadding="0" | ||
!width="100"| 模块 | !width="100"| 模块 | ||
2017年8月7日 (一) 19:15的版本
目录
简介
批量导出类接口提供批量导出轨迹数据功能，该类接口将一段时间内的轨迹数据打包成文件，生成下载链接供开发者下载。该类接口包括三个 API：
| 模块 | 接口名称 | 功能说明 |
|---|---|---|
| export | createjob | 创建一个任务，该任务完成后将返回文件下载地址，供开发者下载 |
| deletejob | 删除任务 | |
| getjob | 查询任务，将返回任务状态和文件下载地址 |
使用说明
批量导出接口类接口使用步骤为：
第一步：使用 createjob接口创建任务，获得任务 id
第二步：使用 getjob 接口定期查询任务状态，一旦返回值中的 job_status 字段为"done"时，取出 file_url 字段中的下载链接，开发者可使用自己熟悉的下载工具从该链接下载轨迹文件。
注意事项：
1. 每一次请求最多下载一天内的轨迹。例如：若需下载最近7天的轨迹，则需创建7个任务，生成7个数据文件下载
2.下载文件生成成功后，开发者需尽快下载文件，鹰眼将在48小时后删除服务端的文件
坐标系说明
目前中国主要有以下三种坐标系：
WGS84：为一种大地坐标系，也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。
GCJ02：是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。
BD09：为百度坐标系，在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标，bd09mc表示百度墨卡托米制坐标
非中国地区地图，统一使用WGS84坐标
鹰眼 Web服务API v3.0的默认输入输出坐标为百度经纬度坐标系（bd09ll），同时可通过"coord_type"
，"coord_type_input"，"coord_type_output"（以各服务参数介绍为准）控制输入输出的坐标类型，鹰眼将自动完成转换。
createjob—— 创建任务
接口说明
创建一个新的轨迹数据导出任务，下载该service 内一段时间内的全部轨迹。
注意：
1. 每一个任务最多下载一天的全量轨迹。例如，若下载7天的轨迹，则需创建7个任务
2. 每个service_id同时只允许存在10个未完成任务，超过10个则返回创建失败，请等待现有的任务处理完之后再创建新的任务
请求URI
http://yingyan.baidu.com/api/v3/export/createjob
HTTP请求方式
POST
请求参数
| 参数名 | 参数含义 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| ak | 用户的ak | string | 是 | |
| service_id | service的ID，service 的唯一标识。 | int | 是 | 在轨迹管理台创建鹰眼服务时，系统返回的 service_id
|
| start_time | 轨迹起始时间 | UNIX 时间戳 | 是 | |
| end_time | 轨迹结束时间（不能超过当前时间） | UNIX 时间戳 | 是 | 起始时间和结束时间差在24小时之内。 |
| coord_type_output | 返回的坐标类型 | string | 否 | 默认值：bd09ll
该字段用于控制返回结果中的坐标类型。可选值为： gcj02：国测局加密坐标 bd09ll：百度经纬度坐标 该参数仅对国内（包含港、澳、台）轨迹有效，海外区域轨迹均返回 wgs84坐标 |
返回参数
| 参数名 | 参数含义 | 类型 | 备注 |
|---|---|---|---|
| status | 状态码 | int | 返回状态，0为成功 |
| message | 响应信息 | string | 对status的中文描述 |
| job_id | 任务 id | int | 任务id，每个任务的唯一标识 |
请求示例
以下载2016年8月7日的轨迹数据为例：
返回示例
| JSON |
|---|
{
"status": 0, "message": "成功" "job_id" : 1 } |
deletejob—— 删除任务
接口说明
根据job_id删除任务
请求URI
http://yingyan.baidu.com/api/v3/export/deletejob
HTTP请求方式
POST
请求参数
| 参数名 | 参数含义 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| ak | 用户的ak | string | 是 | |
| service_id | service的ID，service 的唯一标识。 | int | 是 | 在轨迹管理台创建鹰眼服务时，系统返回的 service_id
|
| job_id | 任务id | int | 是 | 每个任务的唯一标识 |
返回参数
| 参数名 | 参数含义 | 类型 | 备注 |
|---|---|---|---|
| status | 状态码 | int | 返回状态，0为成功 |
| message | 响应信息 | string | 对status的中文描述 |
请求示例
返回示例
| JSON |
|---|
{
"status": 0, "message": "成功" } |
|}
getjob——查询任务
接口说明
查询任务池中的任务，任务池中包括以下几类任务：
1. 已创建尚未开始执行的任务
2. 正在执行的任务
3. 已完成的任务，但完成时间不超过48小时（注：已完成的任务会在48小时之后自动清理）
已完成的任务会返回file_url，将地址粘贴至浏览器或使用其他下载方法，即可获得轨迹数据文件。
请求URI
http://yingyan.baidu.com/api/v3/export/getjob
HTTP请求方式
GET
请求参数
| 参数名 | 参数含义 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| ak | 用户的ak | string | 是 | |
| service_id | service的ID，service 的唯一标识。 | int | 是 | 在轨迹管理台创建鹰眼服务时，系统返回的 service_id |
返回参数
| 参数名 | 参数含义 | 类型 | 备注 | |
|---|---|---|---|---|
| status | 状态码 | int | 返回状态，0为成功 | |
| message | 响应信息 | string | 对status的中文描述 | |
| total | 任务总条数 | int | 当前service_id下的任务总数 | |
| jobs | 任务总条数 | int | 当前service_id下的任务总数 | |
| job_id | 任务id | int | ||
| start_time | 轨迹起始时间 | UNIX 时间戳 | ||
| end_time | 轨迹结束时间 | UNIX 时间戳 | ||
| coord_type_output | 返回的坐标类型 | 返回值的坐标类型。可能返回的值为：
gcj02：国测局加密坐标 bd09ll：百度经纬度坐标 该参数仅对国内（包含港、澳、台）轨迹有效，海外区域轨迹均返回 wgs84坐标 | ||
| create_time | 任务创建的格式化时间 | string | 该时间为服务端时间 | |
| create_time | 任务创建的格式化时间 | string | 该时间为服务端时间 | |
| modify_time | 任务创建的格式化时间 | string | 该时间为服务端时间 | |
| job_status | 任务当前的执行状态 | string | 取值范围：
waiting：待处理 running：正在准备数据 done：数据已准备完成，已生成可供下载的数据文件 | |
| file_url | 轨迹数据文件下载链接 | string | 数据准备好后（即：job_status为 done 时），将会生成轨迹数据文件下载链接，开发者可通过该链接下载数据文件。注：已完成的任务会在48小时之后自动清理，请及时下载。 | |
导出文件说明
1. 导出文件名为格式为：{service_id}_{job_id}.zip（例如：135252_10.zip）
2. 使用zip解压工具解压可以得到文件：{service_id}_{job_id}.json（例：135252_10.json）
3. 文件中每行文本代表一条轨迹数据，json格式，其中：
- entity_name是entiy的唯一标识，字符串类型；entity_id是鹰眼内部使用的id，可以忽略
- 速度、方向、自定义字段等都存放在custom_data结构中，value统一是字符串类型
- coord_type是坐标类型字段，分为3种：COORD_TYPE_WGS84LL（GPS经纬度）、COORD_TYPE_GCJ02LL（国测局经纬度）、COORD_TYPE_BD09LL（百度加密经纬度）
- 轨迹数据是乱序的，同一个entity的轨迹数据需要按loc_time字段排序后使用
请求示例
返回示例
| JSON |
|---|
{
"status": 0,
"message": "成功",
"total": 2,
"jobs": [
{
"job_id": 1239,
"service_id": 142322,
"start_time": 1470499200,
"end_time": 1470585599,
"coord_type_output": "bd09ll",
"create_time": "20170807182734",
"modify_time": "20170807182741",
"job_status": "done",
"file_url": " http://下载地址"
},
{
"job_id": 1238,
"service_id": 142322,
"start_time": 1470499200,
"end_time": 1470585599,
"coord_type_output": "bd09ll",
"create_time": "20170807182733",
"modify_time": "20170807182741",
"job_status": "done",
"file_url": "http://下载地址"
}
]
} |
导出文件示例
