百度地图LBS云存储APIv30接口说明文档.docx
《百度地图LBS云存储APIv30接口说明文档.docx》由会员分享，可在线阅读，更多相关《百度地图LBS云存储APIv30接口说明文档.docx（53页珍藏版）》请在冰点文库上搜索。
XX地图LBS云存储APIv30接口说明文档
LBS.云v3.0
云存储API接口说明文档
XX在线网络技术（北京）有限公司
2013年11月07日北京
法律说明
版权所有XX在线网络技术有限公司。
本文档包含的所有内容除特别声明之外，版权均属于XX在线网络技术有限公司所有，XX可在不作任何申明的情况下对本文档内容进行修改。
本文档中所使用的商标所有权属于该商标的所有者。
文件说明
文件标识：
Baidu_LBSYun_3.0
当前版本：
2014_01_V3.0
作者：
Baidu_Map_PM
创建日期：
2013-04-11
最新更新：
2014-1-9
更新
2013-10-27
添加参数，修改参数备注说明
2013-11-07
支持唯一索引字段；优化批量上传接口，增加查看进度接口
2013-12-09
自定义配置参数的数据类型以及备注说明部分的细化更新
2014-01-09
添加支持图片存储功能，对自定义字段进行近一步的详细说明
XX在线网络技术有限公司
邮箱：
****************
地址：
北京市海淀区上地信息路9号甲奎科科技大厦
邮编：
100085
XX地图LBS开放平台：
XX地图API网址：
XX地图API论坛：
一、LBS云存储APIv3（数据存储管理接口）接口说明
1．概念实体字段定义
1.1位置数据表（geotable）实体字段定义
1.2自定义扩展列（column）实体字段定义
1.3位置数据（poi）实体字段定义
2．位置数据表（geotable&column）管理
2.1创建表（creategeotable）接口
2.2条件查询表（list geotable）接口
2.3查询指定id表信息（detailgeotable）接口
2.4修改表（updategeotable）接口
2.5删除表（deletegeotable）接口
2.6创建列（createcolumn）接口
2.7条件查询列（listcolumn）接口
2.8查询指定id列（detailcolumn）详情接口
2.9修改指定条件列（updatecolumn）接口（支持批量条件修改）
2.10删除指定条件列（deletecolumn）接口（支持批量条件删除）
3.位置数据（poi）管理
3.1创建数据（createpoi）接口
3.2条件查询数据（listpoi）列表接口
3.3查询指定id的数据（detailpoi）详情接口
3.4修改数据（updatepoi）接口
3.5删除单个数据（deletepoi）接口（支持批量）
3.6批量上传数据（postpoiscsvfile）接口
3.7批量上传进度查询接口（支持查询成功，失败poi）
4.批量操作任务（JOB）查询进度接口
4.1批量操作任务查询（listjob）接口
4.2根据id查询批量任务（detailjob）接口
5.返回码定义值表
使用说明：
1.请先了解名词意义：
“位置数据表（geotable）”、“自定义扩展列（column）”、“位置数据（poi）”概念的意义，更有助于开发。
2.云存储接口功能：
支持单个geotable亿级数据及数百G大小的存储，每天支持百万量级读写，每秒支持万量级读写。
3.批量操作说明：
V2版本，引入“批量操作”概念。
通过批量操作接口操作，您可实现对一个位置数据表（geotable）进行如下操作：
●批量上传多条数据；
●批量删除多条数据；
●批量删除1个或者多个自定义扩展列（column）；
●批量更新数据（如字段、字段属性、字段对应的值等）等操作
“批量操作”接口原理及使用说明如下：
●“批量操作”接口是采用异步服务形式，您可使用此接口对一个位置数据表（geotable）同时执行各种批量操作，服务将在并发数范围内同时处理多个请求任务，超出并发数的请求任务将以消息队列形式进入处理等待状态。
●当您使用批量操作接口时，服务将先发送批量操作请求，若请求成功，系统将锁定对应的位置数据表（geotable），即用户可对此表进行可读操作，不能进行任何写操作，直到此次批量操作任务完成（即任务进度状态码Status=3完成时）自动解锁，恢复可写。
同时，系统会返回状态码Status=21和此操作（Jobid），Status值用于标识您的操作为批量操作，Jobid用于查询此批量操作的任务进度。
（Status=0表示非批量操作的普通操作）。
●查询某个批量操作任务进度，即根据上述返回的Jobid，使用批量操作任务查询进度接口进行查询。
根据返回的任务进度状态码值（1、2、3）确认批量操作的进度（新增操作，消息队列中等待处理；正在处理；完成）。
1．云存储字段定义方式
1.1位置数据表（geotable）实体字段定义
geotable字段定义
字段名称
字段含义
类型
备注
id
id,记录的唯一标识
uint32
name
geotable的中文名称
string（45）
geotype
geotable包含的数据类型，包含点、线、面三种类型
uint32
1：
点；2：
线；3：
面。
默认为1（当前只支持点）。
modify_time
记录最后一次被修改的时间
datetime
create_time
记录被创建的时间
datetime
user_id
创建此记录的用户标识
uint64
1.2自定义扩展列（column）实体字段定义
字段名
含义
类型
是否必须
默认值
备注
id
唯一标识
UInt64
是
无
key
存储在geotable的key标识
String（64）
是
无
在同一geotable内唯一
正则:
[a-zA-Z][0-9a-zA-Z_]*
name
对key的描述
String（128）
否
无
type
字段类型
UInt32
是
无
1：
Int64,2:
double,3,string;4：
在线图片url，LBS图片存储
max_length
最大长度
UInt32
否
无
1,针对String是必须
2,最大值不超过2048
default_value
默认值
String（32）
否
无
1,如果此列被设置成排序筛选字段,则default_value必须进行设置.否则默认为0
is_sortfilter_field
是否将字段设置为云检索时的排序筛选字段
UInt32
是
1代表是，0代表否。
设置后效果详见
最多只能设置15个
只有int或者double类型可以设置
sortfilter_id
排序筛选字段id
UInt32
否
1-15,在同一geotable内不能重复.
is_search_field
是否设置为检索时的文本检索字段
UInt32
是
1代表是，0代表否。
设置后可根据对该字段的内容要求进行检索
只能针对String类型的字段,最大设置大小不超过2048,最多不超过4个
is_index_field
是否将字段设置为索引字段。
UInt32
否
1代表是，0代表否。
设置后可实现方便快速查询。
最多设置2个
注：
is_index_field=1时才能在根据该列属性值检索到数据
设置后对应功能：
is_unique_field
是否将字段设置为唯一索引字段。
UInt32
否
1代表是，0代表否。
设置后方便更新，删除，查询
最多设置1个
create_time
创建时间
UInt32
是
Unix时间戳
modify_time
修改时间
UInt32
是
Unix时间戳
1.3位置数据（poi）实体字段定义
字段名
含义
类型
是否必须
默认值
备注
id
唯一标识
UInt64
是
无
location
坐标
Array
是
无
格式为：
[经度,纬度]或者[对应的墨卡托投影]
province
省名称
String（32）
否
无
city_id
市id
UInt32
是
无
city
市名
String（32）
是
无
district
区名
String（64）
否
title
名称
String（256）
否
address
地址
String（256）
否
coord_type
用户上传的坐标的类型
UInt32
否
3
可选，1.GPS经纬度坐标
2.国测局加密经纬度坐标
3.XX加密经纬度坐标
4.XX加密墨卡托坐标
tags
标签
String（256）
否
以空格分隔
geotable_id
表主键
UInt32
是
create_time
创建时间
UInt32
是
Unix时间戳
modify_time
修改时间
UInt32
是
Unix时间戳
2．位置数据表（geotable&column）管理
2.1创建表（creategeotable）接口
2.1.1请求url
POST请求
2.1.2 请求参数
参数名
参数含义
类型
备注
name
Geotable的中文名称
String（45）
必选
geotype
Geotable持有数据的类型
Int32
必选
1：
点poi
2：
线poi
3：
面poi，
默认为1
is_published
是否发布到检索
Int32
必选
0：
未自动发布到云检索，
1：
自动发布到云检索；
策略提示：
注：
1）通过URL方式创建表时只有is_published=1时在云检索时表内的数据才能被检索到
2）通过数据管理模块时：
。
timestamp
时间戳
UInt32
可选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.1.3 响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
必须
对status的英文描述
id
新增的数据的id
String
必须
2.1.4 请求响应示例（截图来自chrome浏览器插件：
“POSTMAN”工具，下同）
2.2查询表（listgeotable）接口
2.2.1请求url
GET请求
2.2.2请求参数
参数名
参数含义
类型
备注
name
geotable的名字
String（45）
可选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.2.3响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
必须
对status的英文描述
size
数据个数
Int32
geotables
Geotable列表
Array
id
Geotable的主键
String
Geotype
Geo类型
Name
Geotable的中文名称
String
Is_published
是否发布到检索
Int32
Create_time
创建日期
String
Modify_time
最近一次修改时间
String
2.2.4 请求响应示例
2.3查询指定id表（detailgeotable）接口
2.3.1请求url
GET请求
2.3.2请求参数
参数名
参数含义
类型
备注
id
指定geotable的id
Int32
必选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.3.3响应参数（json格式）
参数名
参数含义
类型
备注
Status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
Message
响应的信息
String（50）
对status的英文描述
Geotable
Geotable
Dict
id
Geotable的主键
String
Geotype
Geo类型
Name
Geotable的中文名称
String
Is_published
是否发布到检索
Int32
Create_time
创建日期
String
Modify_time
最近一次修改时间
String
2.3.4 请求响应示例
2.4修改表（updategeotable）接口
2.4.1请求url
POST请求
2.4.2请求参数
参数名
参数含义
类型
备注
id
geotable主键
UInt32
必选
is_published
是否发布到检索
int32
会引起批量操作
name
Geotable的中文名称
String（45）
可选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.4.3响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
对status的英文描述
2.4.4 请求响应示例
2.5删除表（geotable）接口
2.5.1请求url
POST请求
注：
当geotable里面没有有效数据时，才能删除geotable
2.5.2请求参数
参数名
参数含义
类型
备注
id
表主键
UInt32
必选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.5.3响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
对status的英文描述
2.5.4 请求响应示例
2.6创建列（createcolumn）接口
2.6.1请求url
POST请求
2.6.2请求参数
参数名
参数含义
类型
备注
name
Column的属性中文名称
String（45）
必选
key
column存储的属性key
String（45）
必选，同一个geotable内的名字不能相同
type
存储的值的类型
UInt32
必选，枚举值
1：
Int64,2:
double,3,string，4，在线图片url
max_length
最大长度
UInt32
必选
最大值2048，最小值为1，针对string有效，并且string时必填。
此值代表utf8的汉字个数，不是字节个数
default_value
默认值
String（45）
设置默认值
is_sortfilter_field
是否检索引擎的数值排序筛选字段
UInt32
必选，1代表是，0代表否。
设置后效果详见
最多只能设置15个
只有int或者double类型可以设置
is_search_field
是否检索引擎的文本检索字段
UInt32
必选，1,代表支持，0为不支持。
只有string可以设置
检索字段只能用于字符串类型的列且最大长度不能超过512个字节
Is_index_field
是否存储引擎的索引字段
UInt32
必选，用于存储接口查询
1,代表支持，0为不支持。
注：
is_index_field=1时才能在根据该列属性值检索时检索到数据。
设置后可用功能：
is_unique_field
是否云存储唯一索引字段
UInt32
可选
用于更新，删除，查询：
1代表支持，0为不支持
geotable_id
所属于的geotable_id
String（50）
必选
ak
用户的访问权限key
String（50）
必选
sn
用户的权限签名
String（50）
可选
2.6.3响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
对status的英文描述
id
新增的数据id
UInt32
必选。
2.6.4 请求响应示例
2.7查询列（listcolumn）接口
2.7.1请求url
GET请求
2.7.2请求参数
参数名
参数含义
类型
备注
name
Geotablemeta的属性中文名称
String（45）
可选
key
Geotablemeta存储的属性key
String（45）
可选
geotable_id
所属于的geotable_id
String（50）
必选
ak
用户的访问权限key
String
必选
sn
用户的权限签名
String
可选
2.7.3响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
对status的英文描述
size
返回数据条数
UInt32
必选
columns
数据
Array
Id
id
String
必选
Geotable_id
所属于的geotable_id
String
必选
name
中文名称
String
必选
key
存储的属性key
String
必选
type
存储的值的类型
UInt32
必选
max_length
列的最大长度
Uint32
default_value
列的默认値
String（32）
create_time
列的创建时间
UInt32
modify_time
列的修改时间
UInt32
Is_sortfilter_field
是否检索端排序字段
UInt32
Is_search_field
是否检索端文本检索字段
UInt32
Is_index_field
是否存储管理索引字段
UInt32
is_unique_field
是否存储管理唯一索引字段
UInt32
2.7.4 请求响应示例
2.8查询指定id列（detailcolumn）详情接口
2.8.1请求url
GET请求
2.8.2请求参数
参数名
参数含义
类型
备注
id
列的id
UInt32
必选
geotable_id
表的id
UInt32
必选
ak
用户的访问权限key
String
必选
sn
用户的权限签名
String
可选
2.8.3 响应参数（json格式）
参数名
参数含义
类型
备注
status
状态码
Int32
必须。
0代表成功，其它取值含义另行说明
message
响应的信息
String（50）
对status的英文描述
column
数据
Dict
id
id
String
必选
geotable_id
所属于的geotable_id
String
必选
name
中文名称
String
必选
key
存储的属性key
String
必选
type
存储的值的类型
UInt32
必选
max_length
列的最大长度
UInt32
default_value
列的默认値
String（32）
create_time
列的创建时间
UInt32
modify_time
列的修改时间
UInt32
is_
升级会员 