|
|
(未显示1个用户的26个中间版本) |
第1行: |
第1行: |
− | {{cloud-sidebar}}
| |
− | ==使用说明==
| |
− | 请先阅读名词解释: “[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)]”,更有助于开发。
| |
| | | |
− | ==云存储字段定义方式==
| |
− | ===位置数据表(geotable)实体字段定义===
| |
− | {|
| |
− | !width="100"|字段名
| |
− | !width="150" |含义
| |
− | !width="100"|类型
| |
− | !width="350"|备注
| |
− | |-
| |
− | |id
| |
− | |id
| |
− | |uint32
| |
− | |即geotable_id,为唯一标识
| |
− | |-
| |
− | |user_id
| |
− | |用户id
| |
− | |uint64
| |
− | |
| |
− | |-
| |
− | |geotype
| |
− | |数据类型
| |
− | |uint32
| |
− | |1(点)、3(面)
| |
− | |-
| |
− | |modify_time
| |
− | |最后一次被修改的时间
| |
− | |datetime
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |创建的时间
| |
− | |datetime
| |
− | |
| |
− | |}
| |
− |
| |
− | ===自定义扩展列(column)实体字段定义===
| |
− | {|
| |
− | !width="100"|字段名
| |
− | !width="150"|含义
| |
− | !width="100"|类型
| |
− | !width="350"|备注
| |
− | |-
| |
− | |id || id || uint64 || 为唯一标识
| |
− | |-
| |
− | |key || key || string(64) || 格式为正则:[a-zA-Z][0-9a-zA-Z_]*,即由英文字符、数字和下划线组成,且首字母要求为英文字符 <br/>为唯一标识
| |
− | |-
| |
− | |name || 对column的描述或释义 || string(128) ||
| |
− | |-
| |
− | |type || 字段类型 || int32 || 1(Int64)、2(double)、3(string)、4(在线图片URL)
| |
− | |-
| |
− | |max_length || 最大长度 || int32 || 当type为string时,此项为必选,最大值为2048
| |
− | |-
| |
− | |default_value ||默认值 || string(32) || 默认值为0
| |
− | |-
| |
− | |is_index_field || 是否为云存储所用的索引字段 || uint32 || 1(是)、0(否) <br/>设置后,云存储可以对该字段的内容进行检索 <br/>最多设置3个索引字段
| |
− | |-
| |
− | |is_unique_field || 是否为云存储所用的唯一索引字段 ||uint32 || 1(是)、0(否) <br/>设置后将在数据创建和更新时进行该字段唯一性检查,并可以以此字段为条件进行数据的更新、删除和查询 <br/>为唯一标识
| |
− | |-
| |
− | |is_search_field || 是否为[[lbscloud/api/geosearch|云检索]]所用的文本检索字段 || uint32 || 1(是)、0(否),只针对type为string类型的字段 <br/>设置后,云检索可以对该字段的内容进行检索 <br/>最多设置4个文本检索字段
| |
− | |-
| |
− | |is_sortfilter_field || 是否为[[lbscloud/api/geosearch|云检索]]所用的排序筛选字段 || uint32 || 1(是)、0(否) <br/>最多设置15个排序筛选字段
| |
− | |-
| |
− | |sortfilter_id || 排序筛选字段id || uint32 || 自动分配,值为1-15的唯一标识数字
| |
− | |-
| |
− | |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) || 多个tag以空格分隔
| |
− | |-
| |
− | |location || 坐标 || array || 格式为:[经度,纬度]或者[对应的墨卡托投影]
| |
− | |-
| |
− | |coord_type || 坐标类型 || uint32 || 1(GPS经纬度坐标)、2(国测局加密经纬度坐标)、3(百度加密经纬度坐标)、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/v3/geotable/create //POST请求
| |
− | </pre>
| |
− | '''请求参数'''<br/>
| |
− | {|
| |
− | !参数名
| |
− | !width="100"|参数含义
| |
− | !width="100"|类型
| |
− | !备注
| |
− | |-
| |
− | |name ||geotable的中文名称 ||string(45) ||必选
| |
− | |-
| |
− | |geotype ||geotable持有数据的类型 || int32 ||必选<br/>1:点;2:线;3:面。默认为1(当前不支持“线”)
| |
− | |-
| |
− | |is_published || 是否发布到检索 || int32 || 必选 <br/> 0:未自动发布到云检索,<br/>1:自动发布到云检索;<br/>注:1)通过URL方式创建表时只有is_published=1时 在云检索时表内的数据才能被检索到。<br/>2)可通过数据管理模块设置,在设置中将是否发送到检索一栏中选定为是即可。
| |
− | |-
| |
− | |ak ||用户的访问权限key ||string(50) ||必选
| |
− | |-
| |
− | |sn ||用户的权限签名 ||string(50) ||可选
| |
− | |-
| |
− | |timestamp || 时间戳 ||uint32 ||可选,配合sn使用,增加时间戳安全验证
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''<br/>
| |
− | {|
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status ||状态码 ||int32 ||0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message ||响应的信息 ||string(50) ||状态码描述
| |
− | |-
| |
− | |id ||新增的数据的id ||string ||
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''(截图来自chrome浏览器插件:"POSTMAN"工具,下同)<br/>
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-1.jpg
| |
− |
| |
− | ===查询表(list geotable)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/geotable/list // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |name
| |
− | |geotable的名字
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |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
| |
− | |
| |
− | |geotable列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |geotable的主键
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotype
| |
− | |geo类型
| |
− | |
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |geotable的中文名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到检索
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |最近一次修改时间
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-2.jpg
| |
− |
| |
− | ===查询指定id表(detail geotable)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/geotable/detail // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |指定geotable的id
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |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"| geotable
| |
− | |
| |
− | |geotable列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |geotable的主键
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotype
| |
− | |geo类型
| |
− | |
| |
− | |
| |
− | |-
| |
− | |name
| |
− | |geotable的中文名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到检索
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |最近一次修改时间
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-3.jpg
| |
− |
| |
− | ===修改表(update geotable)接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/geotable/update // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |geotable主键
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |is_published
| |
− | |是否发布到检索
| |
− | |int32
| |
− | |会引起批量操作
| |
− | |-
| |
− | |name
| |
− | |geotable的中文名称
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-4.jpg
| |
− |
| |
− | ===删除表(geotable)接口 ===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/geotable/delete // POST请求
| |
− | //注:当geotable里面没有有效数据时,才能删除geotable
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |表主键
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-5.jpg
| |
− |
| |
− | ==数据列(column)管理==
| |
− |
| |
− | ===创建列(create column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/column/create // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="80" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="80" | 类型
| |
− | !width="200" | 备注
| |
− | |-
| |
− | |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。当type为string该字段有效,此时该字段必填。此值代表utf8的汉字个数,不是字节个数
| |
− | |-
| |
− | |default_value
| |
− | |默认值
| |
− | |string(45)
| |
− | |设置默认值
| |
− | |-
| |
− | |is_sortfilter_field
| |
− | |是否检索引擎的数值排序筛选字段
| |
− | |uint32
| |
− | |必选<br/>1代表是,0代表否。设置后,在请求[[lbscloud/api/geosearch | LBS云检索]]时可针对该字段进行排序。该字段只能为int或double类型,最多设置15个
| |
− | |-
| |
− | |is_search_field
| |
− | |是否检索引擎的文本检索字段
| |
− | |uint32
| |
− | |必选<br/>1代表支持,0为不支持。只有type为string时可以设置检索字段,只能用于字符串类型的列且最大长度不能超过512个字节
| |
− | |-
| |
− | |is_index_field
| |
− | |是否存储引擎的索引字段
| |
− | |uint32
| |
− | |必选<br/>用于存储接口查询:1代表支持,0为不支持<br/>注:is_index_field=1 时才能在根据该列属性值检索时检索到数据
| |
− | |-
| |
− | |is_unique_field
| |
− | |是否云存储唯一索引字段,方便更新,删除,查询
| |
− | |uint32
| |
− | |可选,1代表是,0代表否。设置后将在数据创建和更新时进行该字段唯一性检查,并可以以此字段为条件进行数据的更新、删除和查询。最多设置1个
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id
| |
− | |string(50)
| |
− | |
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |新增的数据id
| |
− | |uint32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-6.jpg
| |
− |
| |
− | ===查询列(list column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/column/list // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="250" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |name
| |
− | |geotable meta的属性中文名称
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |key
| |
− | |geotable meta存储的属性key
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |geotable_id
| |
− | |所属于的geotable_id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |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
| |
− | |中文名称
| |
− | |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
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-7.jpg
| |
− |
| |
− | ===查询指定id列(detail column)详情接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/column/detail // GET请求
| |
− | </source>
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |列的id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |表的id
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |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
| |
− | |中文名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |key
| |
− | |存储的属性key
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |存储的值的类型
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |max_length
| |
− | |列的最大长度
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |default_value
| |
− | |列的默认值
| |
− | |string(32)
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |列的创建时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |列的修改时间
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_sortfilter_field
| |
− | |是否是[[lbscloud/api/geosearch | LBS云检索]]排序字段
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_search_field
| |
− | |是否是[[lbscloud/api/geosearch | LBS云检索]]文本检索字段
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_index_field
| |
− | |是否是云存储索引字段
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |is_unique_field
| |
− | |是否是云存储唯一索引字段
| |
− | |uint32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-8.jpg
| |
− |
| |
− | ===修改指定条件列(column)接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/column/update // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |列主键
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |所属表主键
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |name
| |
− | |属性中文名称
| |
− | |string(45)
| |
− | |可选
| |
− | |-
| |
− | |default_value
| |
− | |默认值
| |
− | |string
| |
− | |可选
| |
− | |-
| |
− | |max_length
| |
− | |文本最大长度
| |
− | |int32
| |
− | |字符串最大长度,只能改大,不能改小
| |
− | |-
| |
− | |is_sortfilter_field
| |
− | |是否检索引擎的数值排序字段
| |
− | |uint32
| |
− | |1代表是,0代表否,如果poi表中已经有数据,并且发布到了[[lbscloud/api/geosearch | LBS云检索]],修改此字段,会引起批量操作
| |
− | |-
| |
− | |is_search_field
| |
− | |是否检索引擎的文本检索字段
| |
− | |uint32
| |
− | |1代表是,0代表否,如果poi表中已经有数据,并且发布到了[[lbscloud/api/geosearch | LBS云检索]],修改此字段,会引起批量操作
| |
− | |-
| |
− | |is_index_field
| |
− | |是否存储引擎的索引字段
| |
− | |uint32
| |
− | |1代表是,0代表否
| |
− | |-
| |
− | |is_unique_field
| |
− | |是否存储索引的唯一索引字段
| |
− | |uint32
| |
− | |1代表是,0代表否。设置后将在数据创建和更新时进行该字段唯一性检查,并可以以此字段为条件进行数据的更新、删除和查询。最多设置1个
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-9.jpg
| |
− |
| |
− | ===删除指定条件列(column)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/column/delete // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |
| |
− | |
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |
| |
− | |
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-10.jpg
| |
− |
| |
− | == 位置数据(poi)管理==
| |
− | ===创建数据(create poi)接口===
| |
− |
| |
− |
| |
− | ''' 请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/create // POST请求
| |
− | </source>
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |tags
| |
− | |tags
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |latitude
| |
− | |用户上传的纬度
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |longitude
| |
− | |用户上传的经度
| |
− | |double
| |
− | |必选
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |必选<br/>1:GPS经纬度坐标<br/>2:国测局加密经纬度坐标<br/>3:百度加密经纬度坐标<br/>4:百度加密墨卡托坐标
| |
− | |-
| |
− | |geotable_id
| |
− | |记录关联的geotable的标识
| |
− | |string(50)
| |
− | |必选,加密后的id
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |开发者自定义的类型(string、int、double)
| |
− | |唯一索引字段必选,且需要保证唯一,否则会创建失败
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |新增的数据的id
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-11.jpg
| |
− |
| |
− | === 查询指定条件的数据(poi)列表接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/list // GET请求
| |
− | </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
| |
− | |-
| |
− | |title
| |
− | |记录(数据)名称
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |tags
| |
− | |记录的标签(用于检索筛选)
| |
− | |string(256)
| |
− | |可选
| |
− | |-
| |
− | |bounds
| |
− | |查询的矩形区域
| |
− | |string(100)
| |
− | |格式x1,y1;x2,y2分别代表矩形的左上角和右下角,可选
| |
− | |-
| |
− | |geotable_id
| |
− | |geotable_id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |page_index
| |
− | |分页索引
| |
− | |uint32
| |
− | |默认为0
| |
− | |-
| |
− | |page_size
| |
− | |分页数目
| |
− | |uint32
| |
− | |默认为10,上限为200
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''3.2.3 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |size
| |
− | |返回数据条数
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |total
| |
− | |全部的数据条数
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |pois
| |
− | |poi结果列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |geotable_id
| |
− | |geotable_id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |location
| |
− | |百度系坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |gcj_location
| |
− | |国测局坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |tags
| |
− | |标签
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |用户修改时间
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |province
| |
− | |所在的省份
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |district
| |
− | |所在的区
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |用户自定义的类类别
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-12.jpg
| |
− |
| |
− | ===查询指定id的数据(poi)详情接口===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/detail // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |poi主键
| |
− | |uint64
| |
− | |必选
| |
− | |-
| |
− | |geotable_id
| |
− | |表主键
| |
− | |int32
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |poi
| |
− | |poi结果列表
| |
− | |dict
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |当不存在唯一索引字段时必选,存在唯一索引字段时可选
| |
− | |-
| |
− | |geotable_id
| |
− | |geotable_id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |{自定义唯一索引key}
| |
− | |Value
| |
− | |自定义类型
| |
− | |若自定义索引字段和id共存时,将优先根据id进行查询
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |location
| |
− | |百度系坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |gcj_location
| |
− | |国测局坐标
| |
− | |float
| |
− | |格式为:[经度,纬度]
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |city
| |
− | |城市
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |province
| |
− | |所在的省份
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |district
| |
− | |所在区域
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |自定义类型
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-13.jpg
| |
− |
| |
− | ===修改数据(poi)接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/update // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |id
| |
− | |poi的id
| |
− | |uint64
| |
− | |当不存在唯一索引字段时必须,存在唯一索引字段可选
| |
− | |-
| |
− | |自定义唯一索引key
| |
− | |Value
| |
− | |用户自定义类型
| |
− | |可选,若自定义索引字段和id共存时,将以id为准,且自定义索引key将被新的value
| |
− | |-
| |
− | |title
| |
− | |poi名称
| |
− | |string(256)
| |
− | |
| |
− | |-
| |
− | |address
| |
− | |地址
| |
− | |
| |
− | |
| |
− | |-
| |
− | |tags
| |
− | |tags
| |
− | |
| |
− | |
| |
− | |-
| |
− | |latitude
| |
− | |用户上传的纬度
| |
− | |double
| |
− | |
| |
− | |-
| |
− | |longitude
| |
− | |用户上传的经度
| |
− | |double
| |
− | |
| |
− | |-
| |
− | |coord_type
| |
− | |用户上传的坐标的类型
| |
− | |uint32
| |
− | |必选<br/>1.GPS经纬度坐标<br/>2.测局加密经纬度坐标<br/>3.百度加密经纬度坐标<br/>4.百度加密墨卡托坐标
| |
− | |-
| |
− | |geotable_id
| |
− | |记录关联的geotable的标识
| |
− | |string(50)
| |
− | |必选,加密后的id
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |用户自定义的的列类别
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-14.jpg
| |
− |
| |
− | ===删除数据(poi)接口(支持批量)===
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/delete // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | ''' 请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="80" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="250" | 备注
| |
− | |-
| |
− | |id
| |
− | |被删除的id
| |
− | |uint64
| |
− | |如果设置了这个参数,其它的删除条件会被忽略,只会根据id删除单条poi。此时此操作不是批量请求。
| |
− | |-
| |
− | |自定义唯一索引key
| |
− | |Value
| |
− | |用户自定义类型
| |
− | |可选,若自定义索引字段和id共存时,优先选择根据id删除poi。
| |
− | |-
| |
− | |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)
| |
− | |可选
| |
− | |-
| |
− | |bounds
| |
− | |查询的矩形区域
| |
− | |string(100)
| |
− | |格式x1,y1;x2,y2分别代表矩形的左上角和右下角
| |
− | |-
| |
− | |geotable_id
| |
− | |geotable_id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |-
| |
− | |{column key}
| |
− | |用户在column定义的key/value对
| |
− | |
| |
− | |
| |
− | |-
| |
− | |is_total_del
| |
− | |标记为批量删除
| |
− | |int32
| |
− | |如果是批量删除,则需要传这个参数,值为1;如果不是批量删除,则不用传这个参数
| |
− | |}
| |
− |
| |
− |
| |
− | '''3.5.3 响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |id
| |
− | |job id
| |
− | |string
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-15.jpg
| |
− |
| |
− | ===批量上传数据(post pois csv file)接口===
| |
− |
| |
− | 注意:该接口每日限调用25次。若对数据的实时性要求较高,建议通过“创建数据(create poi)接口”实现。
| |
− |
| |
− |
| |
− | '''请求url'''
| |
− |
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/poi/upload // POST请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |geotable_id
| |
− | |导入的geotable的标识
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |poi_list
| |
− | |输入的poi列表名称
| |
− | |file
| |
− | |必选,小于8M
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |-
| |
− | |timestamp
| |
− | |时间戳
| |
− | |uint32
| |
− | |必选,配合sn使用,增加时间戳安全验证
| |
− | |}
| |
− |
| |
− | 导入文件(poi_list)的CSV格式:
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |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)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− |
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |job_id
| |
− | |导入job的id
| |
− | |string
| |
− | |用以查询这个job后续的导入情况调用job/listimportdata接口详情见下
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-16.jpg
| |
− |
| |
− | 附:批量导入示例文件(data.csv )
| |
− |
| |
− | http://developer.baidu.com/map/static/img/yun3642.jpeg
| |
− |
| |
− | === 批量上传进度查询接口(支持进度查询和上传失败的poi)===
| |
− |
| |
− | ''' 请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/job/listimportdata // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |geotable_id
| |
− | |导入的geotable的标识
| |
− | |uint32
| |
− | |必选
| |
− | |-
| |
− | |job_id
| |
− | |导入接口返回的job_id
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |status
| |
− | |Poi导入的状态
| |
− | |uint32
| |
− | |默认为0,0为全部,1为失败,2为成功,已经废弃。
| |
− | |-
| |
− | |page_index
| |
− | |分页索引
| |
− | |uint32
| |
− | |默认为0
| |
− | |-
| |
− | |page_size
| |
− | |分页数目
| |
− | |uint32
| |
− | |默认为10,上限为100
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |-
| |
− | |timestamp
| |
− | |时间戳
| |
− | |uint32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |total
| |
− | |导入poi总数目
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |size
| |
− | |当前返回个数
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |process_status
| |
− | |导入进度状态
| |
− | |int32
| |
− | |0为进行中,1为完成
| |
− | |-
| |
− | |process_total
| |
− | |导入总数
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |process_failed
| |
− | |导入失败总数
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |process_success
| |
− | |导入成功总数
| |
− | |
| |
− | |
| |
− | |-
| |
− | |datas
| |
− | |Array[ poi=>array(),//导入的poi信息 msg=>导入状态信息 ]
| |
− | |Array
| |
− | |
| |
− | |-
| |
− | |Header
| |
− | |导入的header信息
| |
− | |Array
| |
− | |
| |
− | |-
| |
− | |time
| |
− | |导入总时间单位s
| |
− | |int32
| |
− | |
| |
− | |}
| |
− |
| |
− | == 批量操作任务(JOB)查询进度接口==
| |
− | === 批量操作接口原理及使用说明===
| |
− |
| |
− | {{bluepoint}}通过“批量操作”接口,可实现对一个位置数据表(geotable)进行各种批量操作,包括:上传多条数据,删除多条数据,删除多个自定义扩展列(column),更新数据(如字段、字段属性、字段对应的值等)等。
| |
− |
| |
− | {{bluepoint}}“批量操作”接口采用异步形式,服务将在并发数范围内同时处理多个请求任务,超出并发数的请求任务将以消息队列形式进入处理等待状态。
| |
− |
| |
− | {{bluepoint}}当您使用批量操作接口时,服务将先发送批量操作请求,若请求成功,系统将锁定对应的位置数据表(geotable),即用户可对此表进行可读操作,不能进行任何写操作,直到此次批量操作任务完成(即任务进度状态码Status = 3 完成时)自动解锁,恢复可写。同时,系统会返回状态码Status =21(表示批量操作)和此操作的Job id(用于查询此批量操作的任务进度)。
| |
− |
| |
− | {{bluepoint}}查询某个批量操作任务进度,即根据上述返回的Job id,使用批量操作任务查询进度接口进行查询。根据返回的任务进度状态码值确认批量操作的进度(1为等待处理,2为正在处理,3为完成)。
| |
− |
| |
− | {{bluepoint}}注意:“批量上传”功能每日限调用25次。<br/>
| |
− |
| |
− | === 批量操作任务查询(list job)接口===
| |
− |
| |
− | ''' 请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/job/list // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |type
| |
− | |job类型
| |
− | |int32(<10)
| |
− | |
| |
− | |-
| |
− | |status
| |
− | |job状态
| |
− | |int32(<10)
| |
− | |1为等待处理,2为正在处理,3为完成。
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | ''' 响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !参数名
| |
− | !参数含义
| |
− | !类型
| |
− | !备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |jobs
| |
− | |job结果列表
| |
− | |array
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |error
| |
− | |错误码
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |poi_fail
| |
− | |导入失败的
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |poi_size
| |
− | |导入总数的
| |
− | |uint32
| |
− | |可能为0
| |
− | |-
| |
− | |poi_success
| |
− | |导入成功的
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |status
| |
− | |状态
| |
− | |int32
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |类型
| |
− | |int32
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-17.jpg
| |
− |
| |
− | ===根据id查询批量任务(detail job)接口===
| |
− |
| |
− | '''请求url'''
| |
− | <source>
| |
− | http://api.map.baidu.com/geodata/v3/job/detail // GET请求
| |
− | </source>
| |
− |
| |
− |
| |
− | '''请求参数'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="150" | 备注
| |
− | |-
| |
− | |id
| |
− | |id
| |
− | |uint64
| |
− | |必选
| |
− | |-
| |
− | |ak
| |
− | |用户的访问权限key
| |
− | |string(50)
| |
− | |必选
| |
− | |-
| |
− | |sn
| |
− | |用户的权限签名
| |
− | |string(50)
| |
− | |可选
| |
− | |}
| |
− |
| |
− |
| |
− | '''响应参数(json格式)'''
| |
− | {|
| |
− | |-
| |
− | !width="100" | 参数名
| |
− | !width="150" | 参数含义
| |
− | !width="100" | 类型
| |
− | !width="250" | 备注
| |
− | |-
| |
− | |status
| |
− | |状态码
| |
− | |int32
| |
− | |0代表成功,其它取值含义另行说明
| |
− | |-
| |
− | |message
| |
− | |响应的信息
| |
− | |string(50)
| |
− | |状态码描述
| |
− | |-
| |
− | |job
| |
− | |job结果列表
| |
− | |dict
| |
− | |
| |
− | |-
| |
− | |id
| |
− | |数据id
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |create_time
| |
− | |用户创建日期
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |modify_time
| |
− | |用户修改时间
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |error
| |
− | |错误码
| |
− | |string
| |
− | |
| |
− | |-
| |
− | |poi_fail
| |
− | |导入失败的
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |poi_size
| |
− | |导入总数的
| |
− | |uint32
| |
− | |可能为0
| |
− | |-
| |
− | |poi_success
| |
− | |导入成功的
| |
− | |uint32
| |
− | |
| |
− | |-
| |
− | |status
| |
− | |状态
| |
− | |int
| |
− | |
| |
− | |-
| |
− | |type
| |
− | |类型
| |
− | |int
| |
− | |
| |
− | |}
| |
− |
| |
− |
| |
− | '''请求响应示例'''
| |
− |
| |
− | http://developer.baidu.com/map/static/img/geodata-18.jpg
| |
− |
| |
− | == 返回码定义值表==
| |
− |
| |
− | 0: 成功
| |
− |
| |
− | 1: 服务器内部错误
| |
− |
| |
− | 2: 参数错误
| |
− |
| |
− | 3: http method错误
| |
− |
| |
− | 21: 此操作为批量操作
| |
− |
| |
− | 22: 同步到检索失败
| |
− |
| |
− | 31: 服务端加锁失败
| |
− |
| |
− | 32: 服务端释放锁失败
| |
− |
| |
− | 1001: 表的name重复
| |
− |
| |
− | 1002: 表的数量达到了最大值
| |
− |
| |
− | 1003: 表中存在poi数据,不允许删除
| |
− |
| |
− | 2001: 列的key重复
| |
− |
| |
− | 2002: 列的key是保留字段
| |
− |
| |
− | 2003: 列的数量达到了最大值
| |
− |
| |
− | 2004: 唯一索引只能创建一个
| |
− |
| |
− | 2005: 更新为唯一索引失败,原poi数据中有重复
| |
− |
| |
− | 2011: 排序筛选字段只能用于整数或小数类型的列
| |
− |
| |
− | 2012: 排序筛选的列已经达到了最大值
| |
− |
| |
− | 2021: 检索字段只能用于字符串类型的列且最大长度不能超过512个字节
| |
− |
| |
− | 2022: 检索的列已经达到了最大值
| |
− |
| |
− | 2031: 索引的列已经达到了最大值
| |
− |
| |
− | 2041: 指定的列不存在
| |
− |
| |
− | 2042: 修改max_length必须比原值大
| |
− |
| |
− | 3001: 更新坐标必须包含经纬度和类型
| |
− |
| |
− | 3002: 唯一索引字段存在重复
| |
− |
| |
− | 3031: 上传的文件太大
| |
− |
| |
− |
| |
− | 控制服务错误码:
| |
− |
| |
− | 请参见[http://developer.baidu.com/map/index.php?title=lbscloud/api/appendix 附录]。
| |