|
|
第1行: |
第1行: |
− | {{cloud-sidebar}}
| |
− | ==服务介绍==
| |
− | 云存储V4版服务在原有“点数据”存储服务基础上,增加了对“面数据”存储管理的功能。
| |
− | 同时,针对存储服务的性能与“容灾”能力也进行了大幅提升。
| |
| | | |
− | <p style="color:red">特别注意:<br>
| |
− | 云存储V4版和V3版使用完全不同的服务架构,存储环境也完全不同。使用V3版服务存储的数据不能通过V4版服务访问。如需使用V4版服务,需使用V4版接口上传数据。
| |
− | <br>
| |
− | 同时,云存储V4版接口存储的数据,只能通过V4版数据管理平台管理(即将推出)
| |
− | <br><br>
| |
− | 使用服务前请确认服务版本:"V4"or"V3"(请求接口URL中有对应标识)</p>
| |
− |
| |
− | ==坐标系说明==
| |
− | WGS84:为一种大地坐标系,也是目前广泛使用的GPS全球卫星定位系统使用的坐标系。
| |
− |
| |
− |
| |
− | GCJ02:是由中国国家测绘局制订的地理信息系统的坐标系统。由WGS84坐标系经加密后的坐标系。
| |
− |
| |
− |
| |
− | BD09:为百度坐标系,在GCJ02坐标系基础上再次加密。其中bd09ll表示百度经纬度坐标,bd09mc表示百度墨卡托米制坐标
| |
− |
| |
− |
| |
− | 云存储 API默认输入坐标类型为百度坐标(BD09),同时可通过参数("coord_type")控制输入坐标类型,输入坐标支持以上三种坐标系。
| |
− |
| |
− | 云存储 API同时返回百度坐标(BD09)和国测局坐标(GCJ02)两类坐标点数据。
| |
− |
| |
− |
| |
− |
| |
− | <p style="color:red">注意:不同类型坐标如需转换,请使用百度地图开放平台提供的[http://lbsyun.baidu.com/index.php?title=webapi/guide/changeposition 标准坐标转换接口]。请勿使用其他渠道提供的坐标转换方法,以免影响坐标转换精度。</p>
| |
− |
| |
− | ==云存储字段定义方式==
| |
− | '''使用说明'''
| |
− |
| |
− | 1.请先了解名词意义: “[http://developer.baidu.com/map/index.php?title=lbscloud/guide/explanation 位置数据表(geotable)]”、 “[http://developer.baidu.com/map/index.php?title=lbscloud/guide/explanation 自定义扩展列(column)]”、“[http://developer.baidu.com/map/index.php?title=lbscloud/guide/explanation 位置数据(poi)]”概念的意义,更有助于开发。
| |
− |
| |
− | 2.云存储接口功能:支持单个geotable亿级数据及数百G大小的存储,每天支持百万量级读写,每秒支持万量级读写。
| |
− |
| |
− | 3.批量操作说明:
| |
− |
| |
− | V2版本,引入“批量操作”概念。通过批量操作接口操作,您可实现对一个位置数据表(geotable)进行如下操作:
| |
− |
| |
− | {{bluepoint}}批量上传多条数据;
| |
− |
| |
− | {{bluepoint}}批量删除多条数据;
| |
− |
| |
− | {{bluepoint}}批量删除1个或者多个自定义扩展列(column);
| |
− |
| |
− | {{bluepoint}}批量更新数据(如字段、字段属性、字段对应的值等)等操作<br/>
| |
− |
| |
− | 4.云存储已全面支持http/https两种请求形式。后文介绍中以http请求为例。
| |
− |
| |
− |
| |
− | '''“批量操作”接口原理及使用说明如下:'''
| |
− |
| |
− | {{bluepoint}}“批量操作”接口是采用异步服务形式,您可使用此接口对一个位置数据表(geotable)同时执行各种批量操作,服务将在并发数范围内同时处理多个请求任务,超出并发数的请求任务将以消息队列形式进入处理等待状态。<br/>
| |
− | {{bluepoint}}当您使用批量操作接口时,服务将先发送批量操作请求,若请求成功,系统将锁定对应的位置数据表(geotable),即用户可对此表进行可读操作,不能进行任何写操作,直到此次批量操作任务完成(即任务进度状态码Status = 3 完成时)自动解锁,恢复可写。同时,系统会返回状态码Status =21和此操作(Job id),Status值用于标识您的操作为批量操作, Job id用于查询此批量操作的任务进度。(Status = 0 表示非批量操作的普通操作)。
| |
− |
| |
− | {{bluepoint}}查询某个批量操作任务进度,即根据上述返回的Job id,使用批量操作任务查询进度接口进行查询。根据返回的任务进度状态码值(1、2、3)确认批量操作的进度(新增操作,消息队列中等待处理;正在处理;完成)。<br/>
| |
− |
| |
− |
| |
− | '''编码说明:'''
| |
− |
| |
− | API请求中需要用到中文或一些特殊字符的参数,为了避免提交到后台乱码,需要对这几个参数值进行编码处理,转换成UTF-8字符的二字符十六进制值,凡是不在下表中的字符都需要进行编码。
| |
− | {|
| |
− | |-
| |
− | !width="74" |字符集合
| |
− | !width="500" |字符
| |
− | |-
| |
− | |URL非保留字
| |
− | |a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 - _ . ~
| |
− | |-
| |
− | |URL保留字
| |
− | |! * ' ( ) ; : @ & = + $ , / ? % # [ ]
| |
− | |}
| |
− | 如果中文参数中使用URL保留字字符的字面意思,例如,检索关键字包含一个问号,此问号也必须进行编码。
| |
− |
| |
− | 附注:
| |
− |
| |
− | (1) javascript中一般采用encodeURIComponent函数对特殊字符进行编码。
| |
− |
| |
− | (2) Java中可以使用函数URLEncoder.encode对特殊字符进行编码。
| |
− |
| |
− | (3) C#中可以使用函数HttpUtility.UrlEncode对特殊字符进行编码。
| |
− |
| |
− | (4) php中可以使用函数urlencode对特殊字符进行编码。
| |
− |
| |
− | ===位置数据表(geotable)实体字段定义===
| |
− | {|
| |
− | !width="100"|字段名
| |
− | !width="150" |含义
| |
− | !width="100"|类型
| |
− | !width="350"|备注
| |
− | |-
| |
− | |id
| |
− | |id
| |
− | |uint32
| |
− | |即geotable_id,为唯一标识
| |
− | |-
| |
− | |name
| |
− | |位置数据表名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |user_id
| |
− | |用户id
| |
− | |uint64
| |
− | |
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到云检索;1(发布)、0(不发布)
| |
− | |uint32
| |
− | |数据表创建完成后,仅允许将发布状态做正向修改(0→1),不允许做逆向修改(1→0)
| |
− | |-
| |
− | |create_time
| |
− | |创建的时间
| |
− | |datetime
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |最后一次修改的时间
| |
− | |datetime
| |
− | |
| |
− | |}
| |
− |
| |
− | ===自定义扩展列(column)实体字段定义===
| |
− | {|
| |
− | !width="100"|字段名
| |
− | !含义
| |
− | !width="80"|类型
| |
− | !width="60"|是否必须
| |
− | !width="50"|默认值
| |
− | !备注
| |
− | |-
| |
− | |id || 唯一标识 || uint64 || 是 || 无 || 该id为创建列时自动生成
| |
− | |-
| |
− | |key || 存储在geotable<br/>的key标识,含义与“id”字段相同,该字段为用户创建时自定义设置 || string(64) || 是 ||无 || 在同一geotable(位置数据表)内唯一正则:<br/>[a-zA-Z][0-9a-zA-Z_]*
| |
− | |-
| |
− | |name || 对key的描述(虎鲸数据管理平台中,列名对应该字段) || string(128) || 否 || 无 ||
| |
− | |-
| |
− | |type || 字段类型 || int32 || 是 || 无 || 1:Int64, 2:double, 3:string, 4:在线图片url,LBS图片存储
| |
− | |-
| |
− | |is_search_field ||是否设置为<b>云检索</b>的排序筛选or检索字段;<br>1代表是,0代表否 ||uint32 ||是 || ||设置后在云检索服务中可根据该字段的内容检索或排序筛选<br/>
| |
− | 若字段为int类型,则为排序筛选字段;<br>
| |
− | 若字段为string类型,则为检索字段
| |
− | |-
| |
− | |is_index_field ||是否将字段设置为<b>云存储</b>的索引字段;<br>1代表是,0代表否。 ||uint32 ||否 || || 设置后可使用云存储相关检索接口,对该字段数据进行检索(前缀匹配)。最多设置3个。
| |
− | |-
| |
− | |create_time ||创建时间 ||uint32 ||是 || ||Unix时间戳
| |
− | |-
| |
− | |modify_time ||修改时间 ||uint32 ||是 || ||Unix时间戳
| |
− | |}
| |
− |
| |
− | ===位置数据(poi)实体字段定义===
| |
− | {|
| |
− | !width="100"|字段名
| |
− | !width="150" |含义
| |
− | !width="100"|类型
| |
− | !width="350"|备注
| |
− | |-
| |
− | |id || id || uint64 || 为唯一标识
| |
− | |-
| |
− | |title || 名称 || string(256) ||
| |
− | |-
| |
− | |tags || 分类标签 || string(256) || 参见:[http://lbsyun.baidu.com/index.php?title=lbscloud/poitags POI行业分类]<br/>多个tag以空格分隔
| |
− | |-
| |
− | |location || 坐标 || array || 格式为:[经度,纬度]或[墨卡托坐标]
| |
− | |-
| |
− | |polygons || 多边形边界坐标点 || string || 格式为:经度,纬度;经度,纬度;经度,纬度 <br>单个多边形最多创建400个边界点,最大字符长度为10240。
| |
− | |-
| |
− | |coord_type || 坐标类型 || uint32 || 1(GPS经纬度坐标)、2(国测局加密经纬度坐标)、3(百度加密经纬度坐标,<b>默认</b>)、4(百度加密墨卡托坐标)
| |
− | |-
| |
− | |province || 省 || string(32) ||
| |
− | |-
| |
− | |city || 市 || string(32) ||
| |
− | |-
| |
− | |district || 区 || string(64) ||
| |
− | |-
| |
− | |address || 地址 || string(256) ||
| |
− | |-
| |
− | |geotable_id || 所属geotable id || uint32 ||
| |
− | |-
| |
− | |create_time || 创建时间 || uint32 || Unix时间戳
| |
− | |-
| |
− | |modify_time || 最后一次修改的时间 || uint32 || Unix时间戳
| |
− | |}
| |
− |
| |
− | ==位置数据表(geotable)管理==
| |
− | ===创建表(create geotable)接口===
| |
− | '''请求url'''<br/>
| |
− | <pre>
| |
− | http://api.map.baidu.com/geodata/v4/geotable/create
| |
− | </pre>
| |
− | <b>云存储服务除批量上传外,所有接口post请求和get请求均支持,后文不再赘述</b>
| |
− | <br><br>
| |
− | '''请求参数'''<br/>
| |
− | {|
| |
− | !参数名
| |
− | !width="100"|参数含义
| |
− | !width="100"|类型
| |
− | !备注
| |
− | |-
| |
− | |name ||geotable的中文名称 ||string(45) ||必选
| |
− | |-
| |
− | |is_published || 是否发布到检索 || int32 || 必选 <br/> 0:未自动发布到云检索,<br/>1:自动发布到云检索;<br/>注:1)通过URL方式创建表时只有is_published=1时 在云检索时表内的数据才能被检索到。<br/>2)可通过数据管理模块设置,在设置中将是否发送到检索一栏中选定为是即可。
| |
− | |-
| |
− | |ak ||用户的访问权限key ||string(50) ||必选
| |
− | |-
| |
− | |sn ||用户的权限签名 ||string(50) ||可选,若用户所用AK的校验方式为SN校验时该参数必须([http://lbsyun.baidu.com/index.php?title=lbscloud/api/appendix SN生成算法])<br>
| |
− | <b>若AK设置为SN校验,所有云存储接口均需拼写SN参数,为节省篇幅,后续接口不再单独说明</b>。
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''<br/>
| |
− | {|
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status ||状态码 ||int32 ||0代表成功,其它取值见文档最后状态码说明
| |
− | |-
| |
− | |message ||响应的信息 ||string(50) ||状态码描述
| |
− | |-
| |
− | |id ||新增的数据的id ||string ||即geotable_id
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''(截图来自chrome浏览器插件:"POSTMAN"工具,下同)<br/>
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===查询表(list geotable)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/geotable/list
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |name
| |
− | |geotable的名字
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="200" colspan="2"| 参数名
| |
− | !width="100" | 参数含义
| |
− | !width="80" |类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |colspan="2"|status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |colspan="2"| message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |colspan="2"| size
| |
− | |数据个数
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |rowspan="7" width="80"| geotables
| |
− | | id
| |
− | |geotable的id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |geotable的名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到云检索
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |创建时间
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |修改时间
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===查询指定id表(detail geotable)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/geotable/detail
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |指定geotable的id
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !width="200" colspan="2"| 参数名
| |
− | !width="100" | 参数含义
| |
− | !width="80" |类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |colspan="2"|status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |colspan="2"| message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |rowspan="7" width="80"| geotables
| |
− | | id
| |
− | |geotable的id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |geotable的名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到云检索
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |创建时间
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |修改时间
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E8%A1%A8-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E8%A1%A8-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===修改表(update geotable)接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/geotable/update
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |geotable主键
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到检索;<br>"1"发布,"0"不发布
| |
− | |int32
| |
− | |当数据表中有数据时,不允许该字段"1"→"0",支持"0"→"1"(会触发批量操作,可通过joblist接口查询进度)
| |
− | |-
| |
− | |name
| |
− | |geotable的中文名称
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |批量任务job_id
| |
− | |int32
| |
− | |如果有批量任务(如修改数据表发布状态),会返回该id,便于查询任务状态
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===删除表(geotable)接口 ===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/geotable/delete
| |
− | </source>
| |
− | <b>注意:当geotable里面没有位置数据时,才能删除geotable</b>
| |
− | <br><br>
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |位置数据表id,即geotable_id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%A0%E9%99%A4%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%A0%E9%99%A4%E8%A1%A8%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ==数据列(column)管理==
| |
− |
| |
− | ===创建列(create column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/column/create
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="80" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="80" | 类型
| |
− | !width="200" | 备注
| |
− | |-
| |
− | |name
| |
− | |column的名称描述
| |
− | |string(45)
| |
− | |必选
| |
− | |-
| |
− | |key
| |
− | |column存储的key标识,含义与返回结果中的列“id”字段相同,该字段为用户创建时自定义设置
| |
− | |string(45)
| |
− | |必选,同一个geotable内的名字不能相同
| |
− | |-
| |
− | |type
| |
− | |存储的值的类型
| |
− | |uint32
| |
− | |必选,枚举值1:Int64, 2:double, 3:string, 4:在线图片url
| |
− | |-
| |
− | |is_search_field
| |
− | |【云检索】是否设置为云检索的排序筛选or检索字段;<br>
| |
− | 1代表是,0代表否
| |
− | |uint32
| |
− | |必选<br/>
| |
− | 设置后在云检索服务中可根据该字段的内容检索或排序筛选。
| |
− | <br>若字段为int/double类型,则为排序筛选字段,最多设置15个;
| |
− | <br>若字段为string类型,则为检索字段,最多设置4个,单字段不超过512字节。
| |
− | |-
| |
− | |is_index_field
| |
− | |【云存储】是否将字段设置为云存储的索引字段;
| |
− | 1代表是,0代表否。
| |
− | |uint32
| |
− | |必选<br/>设置后可使用云存储相关检索接口,对该字段数据进行检索(前缀匹配,不区分int or string)。
| |
− | 最多设置3个。
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id
| |
− | |string(50)
| |
− | |
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |column的id
| |
− | |uint32
| |
− | |自动生成,和请求中"key"含义相同
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E5%88%97%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E5%88%97%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===查询列(list column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/column/list
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="250" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |name
| |
− | |geotable数据列中对key的描述内容
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |key
| |
− | |geotable数据列的key标识
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id,若只传该字段,则检索该数据表中所有"列"信息
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="200" colspan="2"| 参数名
| |
− | !width="100" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |colspan="2" | status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |colspan="2" |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |colspan="2" |size
| |
− | |返回数据条数
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |rowspan="13" width="100"| columns
| |
− | |id
| |
− | |id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |列的key描述字段
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |key
| |
− | |列的标识字段
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |存储的值的类型
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |列的创建时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |列的修改时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_search_field
| |
− | |是否为云检索端检索或排序筛选字段
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_index_field
| |
− | |是否为云存储索引字段
| |
− | |uint32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E5%88%97%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E5%88%97%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===查询指定id列(detail column)详情接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/column/detail
| |
− | </source>
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |列的id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |表的id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="200" colspan="2"| 参数名
| |
− | !width="100" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |colspan="2"| status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |colspan="2"| message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |rowspan="13" width="80"| column
| |
− | |id
| |
− | |id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |列的key描述字段
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |key
| |
− | |列的标识字段
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |存储的值的类型
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |列的创建时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |列的修改时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_search_field
| |
− | |是否为云检索端检索或排序筛选字段
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_index_field
| |
− | |是否为云存储索引字段
| |
− | |uint32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E5%88%97%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E5%88%97%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===修改指定条件列(column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/column/update
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |列id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |所属表id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |name
| |
− | |geotable数据列中对key的描述内容
| |
− | |string(45)
| |
− | |可选,前缀匹配
| |
− | |-
| |
− | |is_search_field
| |
− | |是否设置为云检索的排序筛选or检索字段;
| |
− | 1代表是,0代表否
| |
− | |uint32
| |
− | |<b>如果数据表中已经有数据,不允许修改此字段</b>。<br>
| |
− | 设置后在云检索服务中可根据该字段的内容检索或排序筛选。
| |
− | <br>若字段为int/double类型,则为排序筛选字段,最多设置15个;
| |
− | <br>若字段为string类型,则为检索字段,最多设置4个,单字段不超过512字节。
| |
− | |-
| |
− | |is_index_field
| |
− | |是否为云存储的索引字段;
| |
− | 1代表是,0代表否
| |
− | |uint32
| |
− | |<b>如果数据表中已经有数据,不允许修改此字段</b>。
| |
− | 设置后可使用云存储相关检索接口,对该字段数据进行检索(前缀匹配,不区分int or string)。
| |
− | 最多设置3个。
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6%E5%88%97%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6%E5%88%97%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===删除指定条件列(column)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/column/delete
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |列的id
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |表的id
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%A0%E9%99%A4%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6%E5%88%97%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | ''' 返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%A0%E9%99%A4%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6%E5%88%97%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | == 位置数据(poi)管理==
| |
− | ===创建数据(create poi)接口===
| |
− |
| |
− |
| |
− | ''' 请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/create
| |
− | </source>
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string(256)
| |
− | |可选,最多128个utf-8字符
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string(256)
| |
− | |可选,最多128个utf-8字符
| |
− | |-
| |
− | |tags
| |
− | |类别
| |
− | |string(256)
| |
− | |可选,最多200个tag,每个tag最长32个字符。
| |
− | |-
| |
− | |latitude
| |
− | |用户上传的纬度,非百度墨卡托坐标时,取值为[-90,90]
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |longitude
| |
− | |用户上传的经度,非百度墨卡托坐标时,取值为[-180,180]
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |polygons
| |
− | |多边形边界点坐标数据
| |
− | |double
| |
− | |必选
| |
− | 格式为:经度,纬度;经度,纬度;经度,纬度
| |
− | 单个多边形最多创建400个边界点,最大字符长度为10240。
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |必选<br/>1:GPS经纬度坐标<br/>2:国测局加密经纬度坐标<br/>3:百度加密经纬度坐标<br/>4:百度加密墨卡托坐标
| |
− | |-
| |
− | |geotable_id
| |
− | |创建数据的对应数据表id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |开发者自定义的类型(string、int、double)
| |
− | |唯一索引字段必选,且需要保证唯一,否则会创建失败。最大长度2048字节。
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |新增的数据id
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%9B%E5%BB%BA%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | === 查询指定条件的数据(poi)列表接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/list
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="80" | 参数名
| |
− | !width="100" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="250" | 备注
| |
− | |-
| |
− | |{index key}
| |
− | |用户在column定义的key/value对
| |
− | |
| |
− | |column需要设置了is_index_field=1。对于string,是前缀匹配,如需精确匹配请在字段值末尾加$。对于int或者double,则是范围查找,传递的格式为最小值,最大值。当无最小值或者最大值时,用-代替,同时,此字段最大长度不超过50,最小值与最大值都是整数<br/>例:如加入一个命名为color数据类型为string的column,在检索是可设置为“color=red”的形式来检索color字段为red的POI。<br>如加入一个命名为number数据类型为int的column,在检索是可设置为“number=20,-”的形式来检索number字段值大于等于20的POI。
| |
− | |-
| |
− | |title
| |
− | |数据名称
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |tags
| |
− | |数据类型
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |bounds
| |
− | |查询的矩形区域
| |
− | |string(100)
| |
− | |格式x1,y1;x2,y2分别代表矩形的左上角和右下角,可选。<br>范围过大时服务易超时,返回数据为空。<br>建议经度跨度小于0.8,纬度跨度小于0.5。
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |可选,默认值为3<br/>1:GPS经纬度坐标<br/>2:国测局加密经纬度坐标<br/>3:百度加密经纬度坐标<br/>4:百度加密墨卡托坐标
| |
− | |-
| |
− | |geotable_id
| |
− | |查询的数据表id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |page_index
| |
− | |分页索引
| |
− | |uint32
| |
− | |默认为0
| |
− | |-
| |
− | |page_size
| |
− | |分页数目
| |
− | |uint32
| |
− | |默认为10,上限为200
| |
− | |-
| |
− | |start_date
| |
− | |创建日期
| |
− | |string(50)
| |
− | |格式:2017-06-01
| |
− | |-
| |
− | |end_date
| |
− | |修改日期
| |
− | |string(50)
| |
− | |格式:2017-06-01
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''3.2.3 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |size
| |
− | |单页返回的数据条数
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |pois
| |
− | |poi结果列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotable_id
| |
− | |所属数据表id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |location
| |
− | |百度系坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |gcj_location
| |
− | |国测局坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |polygons
| |
− | |边界点坐标。若该字段为空时不召回。
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string
| |
− | |若该字段为空时不召回。
| |
− | |-
| |
− | |tags
| |
− | |标签
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |用户修改时间
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |province
| |
− | |所在的省份
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |city
| |
− | |所在的城市
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |district
| |
− | |所在的区
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |用户自定义的类类别
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6POI%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9A%E6%9D%A1%E4%BB%B6POI%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===查询指定id的数据(poi)详情接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/detail
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |数据对应的id
| |
− | |uint64
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |数据表id
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |poi
| |
− | |poi结果列表
| |
− | |dict
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotable_id
| |
− | |geotable_id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |title
| |
− | |位置数据名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |location
| |
− | |百度系坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |gcj_location
| |
− | |国测局坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |city
| |
− | |城市
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |province
| |
− | |所在的省份
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |district
| |
− | |所在区域
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |自定义类型
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E7%9A%84POI%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%9F%A5%E8%AF%A2%E6%8C%87%E5%AE%9Aid%E7%9A%84POI%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===修改数据(poi)接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/update
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |id
| |
− | |位置数据的id
| |
− | |uint64
| |
− | |必选
| |
− | |-
| |
− | |title
| |
− | |位置数据名称
| |
− | |string(256)
| |
− | |
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |
| |
− | |
| |
− | |-
| |
− | |tags
| |
− | |数据类别
| |
− | |
| |
− | |
| |
− | |-
| |
− | |latitude
| |
− | |用户上传的纬度
| |
− | |double
| |
− | |
| |
− | |-
| |
− | |longitude
| |
− | |用户上传的经度
| |
− | |double
| |
− | |
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |可选,默认3<br/>1.GPS经纬度坐标<br/>2.测局加密经纬度坐标<br/>3.百度加密经纬度坐标<br/>4.百度加密墨卡托坐标
| |
− | |-
| |
− | |geotable_id
| |
− | |对应的位置数据表id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |用户自定义的的列类别
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9POI%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%821.png
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E4%BF%AE%E6%94%B9POI%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | ===删除数据(poi)接口(支持批量)===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/delete
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="80" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="250" | 备注
| |
− | |-
| |
− | |id
| |
− | |被删除的id
| |
− | |uint64
| |
− | |如果设置了这个参数,其它的删除条件会被忽略,只会根据id删除单条poi。此时此操作不是批量请求。
| |
− | <b>除该字段外,该接口其他字段均会触发批量任务,任务状态请通过joblist接口查看</b>
| |
− | |-
| |
− | |ids
| |
− | |id列表
| |
− | |以,分隔的id
| |
− | |最多1000个id, 如果设置了批量删除is_total_del = 1并且没有设置id字段,则优先根据ids删除多条poi, 其它条件将被忽略.
| |
− | |-
| |
− | |{index key}
| |
− | |用户在column定义的key/value对
| |
− | |
| |
− | |column需要设置了is_index_field=1。对于string,是精确匹配;对于int或者double,则是范围查找,传递的格式为:最小值,最大值。当无最小值或者最大值时,用-代替,同时,此字段最大长度不超过50,最小值与最大值都是整数.
| |
− | |-
| |
− | |title
| |
− | |名称
| |
− | |string(256)
| |
− | |可选,精确匹配
| |
− | |-
| |
− | |tags
| |
− | |标签
| |
− | |string(256)
| |
− | |可选,精确匹配
| |
− | |-
| |
− | |geotable_id
| |
− | |指定的位置数据表id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |is_total_del
| |
− | |标记为批量删除
| |
− | |int32
| |
− | |如需删除一条以上数据,在设定数据范围的条件时,还需要将该字段设为1。 {{red | 注意:若仅设为1,而不设定数据范围的条件(如不指定ids、tag等),则默认为删除全表数据 }}
| |
− | |}
| |
− |
| |
− |
| |
− | '''3.5.3 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |批量任务的job id
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 请求响应示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E5%88%A0%E9%99%A4POI%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | ===批量上传数据(post pois csv file)接口===
| |
− |
| |
− | 注意:该接口每日限调用100次。若对数据的实时性要求较高,建议通过“创建数据(create poi)接口”实现。
| |
− |
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/poi/upload // 该接口仅支持POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |geotable_id
| |
− | |导入的geotable的标识
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |poi_list
| |
− | |输入的位置数据列表名称
| |
− | |file
| |
− | |必选,单次上传的数据表小于1000条数据
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |}
| |
− | <br>
| |
− | 导入文件(poi_list)的CSV格式(自定义字段需与默认字段间隔一个空列):
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%89%B9%E9%87%8F%E4%B8%8A%E4%BC%A0%E6%A0%BC%E5%BC%8F.jpeg
| |
− | <br>
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string(45)
| |
− | |必选
| |
− | |-
| |
− | |latitude
| |
− | |用户上传的纬度
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |longitude
| |
− | |用户上传的经度
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |1.GPS经纬度坐标<br/>2.国测局加密经纬度坐标<br/>3.百度加密经纬度坐标<br/>4.百度加密墨卡托坐标
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |用户自定义的类类别
| |
− | |可选
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |polygons
| |
− | |多边形边界坐标
| |
− | |double
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |导入job的id
| |
− | |string
| |
− | |用以查询这个job的导入状态
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%89%B9%E9%87%8F%E4%B8%8A%E4%BC%A0%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%89%B9%E9%87%8F%E4%B8%8A%E4%BC%A0%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | == 批量操作任务(JOB)查询进度接口==
| |
− |
| |
− | === 批量操作任务查询(list job)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v4/job/list
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |id
| |
− | |批量任务的job id
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |page_size
| |
− | |分页大小(单页召回的数据量)
| |
− | |int32
| |
− | |默认10,上限200
| |
− | |-
| |
− | |page_index
| |
− | |翻页
| |
− | |int32
| |
− | |0为第一页
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |查询的位置数据表id
| |
− | |int(32)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |jobs
| |
− | |job结果列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |批量任务job id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |用户修改日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |任务类型
| |
− | |string
| |
− | |sync(发布至云检索)/delete(删除)/uplode(发布至云存储)
| |
− | |-
| |
− | |uplode_num
| |
− | |导入成功的位置数据数量
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |delete_num
| |
− | |删除位置数据的数量
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |status
| |
− | |状态
| |
− | |int32
| |
− | |0(成功);1(运行);2(失败)
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%89%B9%E9%87%8F%E6%93%8D%E4%BD%9C%E4%BB%BB%E5%8A%A1%E6%9F%A5%E8%AF%A2%E6%8E%A5%E5%8F%A3-%E8%AF%B7%E6%B1%82.png
| |
− |
| |
− | '''返回结果示例'''
| |
− |
| |
− | http://mapopen-website-wiki.bj.bcebos.com/lbscloud/img/%E6%89%B9%E9%87%8F%E6%93%8D%E4%BD%9C%E4%BB%BB%E5%8A%A1%E6%9F%A5%E8%AF%A2%E6%8E%A5%E5%8F%A3-%E7%BB%93%E6%9E%9C.png
| |
− |
| |
− | == 返回码定义值表==
| |
− |
| |
− | 0: 成功
| |
− |
| |
− | 1: 这是批量任务, 可通过job接口查询任务状态
| |
− |
| |
− | 11:未知错误
| |
− |
| |
− | 20:geotable不存在
| |
− |
| |
− | 21:geotable的数量达到上限
| |
− |
| |
− | 22:column的数量达到上限
| |
− |
| |
− | 23:is_search_field数量达到上限
| |
− |
| |
− | 24:is_index_field数量达到上限
| |
− |
| |
− | 25:geotable的name重复
| |
− |
| |
− | 26:column的key重复
| |
− |
| |
− | 27:bounds超过最大范围
| |
− |
| |
− | 28:此操作需要表中没有任何poi数据
| |
− |
| |
− | 30:参数错误|过滤条件有错误|坐标转换失败|content-type错误|http的method错误|http的头部错误
| |
− |
| |
− | 31:name: 参数不存在|key: 参数不存在|id: 参数不存在|type: 参数不存在|geotable_id: 参数不存在|longitude/latitude: 参数不存在|coord_type: 参数不存在|poi_list: 参数不存在|type: URL不能作为检索/索引字段
| |
− |
| |
− | 302:天配额超限,限制访问。<span style="color:red">配额超限,对此错误码不需要重试消耗配额和并发资源,如果想增加配额请[http://lbsyun.baidu.com/index.php?title=open/help_index 联系我们]</span>
| |
− |
| |
− | 401:当前并发量已经超过约定并发配额,限制访问。<span style="color:red">并发控制超限,对此错误码不需要重试消耗配额和并发资源,请控制并发量或[http://lbsyun.baidu.com/index.php?title=open/help_index 联系我们]</span>
| |
− |
| |
− |
| |
− |
| |
− |
| |
− | 控制服务错误码:
| |
− |
| |
− | 请参见[http://lbsyun.baidu.com/index.php?title=lbscloud/api/appendix 附录]。
| |