目录
鹰眼Web服务API v2.0接口总览
使用之前,请先了解鹰眼轨迹基本概念。
模块 | 接口名称 | 功能说明 |
---|---|---|
entity | add | 创建entity,并赋属性信息 |
entity | delete | 删除entity |
entity | update | 更新entity属性信息 |
entity | list | 检索符合条件的entity,返回entity属性信息和最新位置。可用于列出entity,也可用于批量查询多个entitiy的位置 |
entity | addcolumn | 为entity创建一个自定义属性字段,并设置是否为检索字段 |
entity | deletecolumn | 删除entity的一个自定义属性字段 |
entity | listcolumn | 列出entity的自定义属性字段 |
track | addpoint | 为track添加一个最新的轨迹点 |
track | addpoints | 为track添加多个轨迹点 |
track | gethistory | 查询某时间段的历史轨迹,支持返回轨迹去噪纠偏后的轨迹点以及里程。 |
track | addcolumn | 为track增加一个自定义属性字段 |
track | deletecolumn | 删除track的一个自定义属性字段 |
track | listcolumn | 列出track的自定义属性字段 |
fence | create | 创建一个围栏 |
fence | delete | 删除一个围栏 |
fence | update | 更新一个围栏 |
fence | list | 查询围栏列表 |
fence | querystatus | 查询围栏内被追踪对象的状态 |
fence | historyalarm | 查询围栏内被追踪对象的历史报警信息 |
conf | set | 设置配置信息(仅配合MTK2502芯片时使用) |
conf | get | 获取配置信息 |
鹰眼轨迹Web服务API v2.0服务接口通用说明
1. HTTP/HTTPS
鹰眼轨迹Web服务API v2.0提供了HTTP和HTTPS两种访问方式。HTTPS的方式访问效率会低一些。服务端使用时建议采用HTTP方式,客户端使用时,在对安全性有要求的情况下,可以使用HTTPS的方式访问。
HTTP方式访问的域名为http://api.map.baidu.com;
HTTPS方式访问的域名为https://api.map.baidu.com。
文档中的域名均为HTTP类型,在这里统一说明,在每个接口中不再单独说明。
2.所有接口的访问URI和POST请求的每个字段名都是小写字母。
3.所有GET请求参数值要进行URL编码。
4. 浏览器请求跨域问题
鹰眼所有 GET 类型的 Web服务API 均支持 jsonp 的 callback 方式调用,可解决浏览器直接请求 web服务API 的跨域问题。
通用输入参数
参数名 | 参数含义 | 类型 | 备注 |
---|---|---|---|
ak | 用户的ak,授权使用 | string | 必须 |
通用返回参数
参数名 | 参数含义 | 类型 | 备注 |
---|---|---|---|
status | 状态码 | int | |
message | 状态码的描述信息 | string | Status对应的中文描述信息 |
附录1:鹰眼服务状态码及对应描述信息
0: 成功
1: 服务器内部错误
2: 参数错误
3: http method错误
4:http content-type错误
21: 此操作为批量操作
22: 同步到检索失败
31: 服务端加锁失败
32: 服务端释放锁失败
1001: 表的name重复
1002: 表的数量达到了最大值
1003: 表中存在poi数据,不允许删除
2001: track的column_key重复
2002: column_key是保留字段
2003: track的属性数量达到了最大值
2004: 唯一索引只能创建一个
2005: 更新为唯一索引失败,原poi数据中有重复
2006: 创建唯一索引失败,原POI数据中该字段为null
2011: 排序筛选字段只能用于整数或小数类型的列
2012: 排序筛选的列已经达到了最大值
2021: 检索字段只能用于字符串类型的列且最大长度不能超过512个字节
2022: 检索的列已经达到了最大值
2031: 索引的列已经达到了最大值
2041: 指定的列不存在
2042: 修改max_length必须比原值大
3001: 更新坐标必须包含经纬度和类型
3002: 唯一索引字段存在重复
3003: 指定entity不存在
3004: track_ids的数量或值不对
3005: entity已存在
3006 查询时间段内的轨迹点过多,无法进行纠偏,请缩短查询时间
3031: 上传的文件太大
4001: 追踪服务的name重复
4002: 追踪服务的数量达到了最大值
4003: 追踪服务中存在poi数据,不允许删除
4004: 指定追踪服务中不包含指定轨迹ID
4005: 指定追踪服务不存在
5001: fence类型和参数不匹配
5002: 相同name的fence已经存在
5003: 指定的fence不存在
5004: 非法的多边形顶点数据
6001: 指定的relation不存在
7001: entity的column_key重复
7002: 指定的entity属性不存在
7003: 唯一检索的entity属性不能批量赋值
7004: 允许添加的entity属性数量达到了最大值
7005: 允许添加的可检索属性数量达到了最大值
7006: 该属性不是可检索属性
7007: 上传的属性文件大小超过限制
8001 查询时间段内的轨迹点过多,无法进行轨迹分析,请缩短查询时间
附录2:控制服务返回码定义
状态码 | 定义 | 注释 |
---|---|---|
0 | 正常 | |
1 | 服务器内部错误 | 该服务响应超时或系统内部错误,请留下联系方式 |
10 | 上传内容超过8M | Post上传数据不能超过8M |
101 | AK参数不存在 | 请求消息没有携带AK参数 |
102 | MCODE参数不存在,mobile类型mcode参数必需 | 对于Mobile类型的应用请求需要携带mcode参数,该错误码代表服务器没有解析到mcode |
200 | APP不存在,AK有误请检查再重试 | 根据请求的ak,找不到对应的APP |
201 | APP被用户自己禁用,请在控制台解禁 | |
202 | APP被管理员删除 | 恶意APP被管理员删除 |
203 | APP类型错误 | 当前API控制台支持Server(类型1), Mobile(类型2, 新版控制台区分为Mobile_Android(类型21)及Mobile_IPhone(类型22))及Browser(类型3),除此之外其他类型认为是APP类型错误 |
210 | APP IP校验失败 | 在申请SERVER类型应用的时候选择IP校验,需要填写IP白名单,如果当前请求的IP地址不在IP白名单或者不是0.0.0.0/0就认为IP校验失败 |
211 | APP SN校验失败 | SERVER类型APP有两种校验方式IP校验和SN校验,当用户请求的SN和服务端计算出来的SN不相等的时候提示SN校验失败 |
220 | APP Referer校验失败 | 浏览器类型的APP会校验referer字段是否存且切在referer白名单里面,否则返回该错误码 |
230 | APP Mcode码校验失败 | 服务器能解析到mcode,但和数据库中不一致,请携带正确的mcode |
240 | APP 服务被禁用 | 用户在API控制台中创建或设置某APP的时候禁用了某项服务 |
250 | 用户不存在 | 根据请求的user_id, 数据库中找不到该用户的信息,请携带正确的user_id |
251 | 用户被自己删除 | 该用户处于未激活状态 |
252 | 用户被管理员删除 | 恶意用户被加入黑名单 |
260 | 服务不存在 | 服务器解析不到用户请求的服务名称 |
261 | 服务被禁用 | 该服务已下线 |
301 | 永久配额超限,限制访问 | 配额超限,如果想增加配额请联系我们 |
302 | 天配额超限,限制访问 | 配额超限,如果想增加配额请联系我们 |
401 | 当前并发量已经超过约定并发配额,限制访问 | 并发控制超限,请控制并发量或联系我们 |
402 | 当前并发量已经超过约定并发配额,并且服务总并发量也已经超过设定的总并发配额,限制访问 | 并发控制超限,请控制并发量或联系我们 |
返回码常见问题请参见论坛帖子“LBS控制服务返回码定义及常见问题汇总”。