示例中心
功能在线体验
控制台
您现在的位置: 开发 > 云图服务API > 参考手册 > 云检索API >

高德 开发 云图服务API 参考手册 云检索API

更新时间:2017年12月04日

本地检索

本地检索是指检索指定云图table id里,对应城市(全国/省/市/区县)范围的POI信息,返回json数据。例如:检索存储在云图里某个table id里的“北京市(city)”的“水果店(keywords)”。当检索区域是全国时,等同于对存储在云图里的数据进行全表检索。keywords是对建立了文本索引字段的对应列内容进行关键字查询;filter和sortrule是对建立筛选排序索引字段的对应列内容进行筛选和检索结果排序,请在数据管理台完成文本/筛选排序字段索引字段的添加或删除。

服务协议:HTTP/HTTPS GET。

  • 本地检索请求

本地检索请求地址:

http://yuntuapi.amap.com/datasearch/local? parameters

parameters 表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

搜索关键词,支持0-9数字,大小写字母(a-z,A-Z)以及所有中文字符

点击查看:keywords对应的文本索引详解

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和_address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值;

5. city=城市名&keywords= (空格)或者是关键字,将返回对应城市的全部数据或对应关键字的数据;

6. 一次请求最多返回2000条数据。

必填

city

设定检索的城市名(中文名称)

1. 支持全国/省/市/区县行政区划范围的检索;

2. city=全国,即对用户全表搜索;

3. 当city值设置非法或不正确时,按照city = 全国返回。

必填

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解

筛选条件:

1.对建立【排序筛选索引字段】进行检索;

2. 请在数据管理台添加或删除筛选排序索引字段,系统默认为_id,_name,_address,_updatetime,_createtime(其中_updatetime,_createtime暂只能用于排序,不能作为过滤字段)

3. 支持多个筛选条件并行使用:多个过滤条件之间使用“+”(代表与关系);

4. 支持对文本类型的字段进行精确匹配;

5. 支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sortrule

排序规则

点击查看:sortrule对应的筛选排序索引详解

两种方式排序:

1.云图系统预设排序法:_weight:相关度权重值排序,返回由高到低的排序检索结果;

规则:sortrule = _weight:0 //降序

2. 支持对在云图数据管理台建立【排序筛选索引字段】的整数或小数字段排序;

规则:

sortrule=字段名:1 (升序);

sortrule=字段名:0 (降序);

示例:

按年龄age字段升序排序,sortrule=age:1

可选

1.当keywords不为空值:默认按_weight相关权重值由高到低的检索结果;

2.当keywords为空值时:默认按照数据的_id升序排序;

3.如果设置自定义排序字段,按照设定返回,例如按照年龄age字段返回年龄从小到大 sortrule = age:1

limit

分页数据条目数(每页数据展现的条数)

最大每页记录数为100

可选

20

page

分页索引,当前页数

>=1

可选

1

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

返回结果字段说明

名称

含义

规则说明

是否必须返回

status

返回状态

值为0或1            

1:成功;            

0:失败

必填

info

返回的状态信息

status = 1,info返回“ok”

错误码说明

必填

count

返回结果总数目


必填

datas



必填


_id

数据id

数据唯一标识

必填

_name

数据名称

类型:string

必填

_location

坐标

支持点数据            

规则:经度,纬度,经纬度支持到小数点后6位

必填

_address

地址


必填

_province

所在省


必填

_city

所在市


必填

_district

所在区


必填,但当用户提供的地址信息不全时,可为空值

<customfield1>

用户自定义字段1



<customfield…>

用户自定义字段…



_createtime

创建时间


必填

_updatetime

更新时间


必填

_image

图片信息

类型:图片

选填,每个上传过图片的点,会返回


_id

图片id的标识




_preurl

经过压缩处理的图片地址

尺寸400*400,若期望获取体积较小的图片文件,建议使用此地址



_url

大图片的地址

最大限制获取1024*1024,若您的原始图片小于该尺寸,将返回原图。



  • 请求示例
http://yuntuapi.amap.com/datasearch/local?tableid=52b155b6e4b0bc61deeb7629&city=北京市&keywords= &filter=type:写字楼&limit=50&page=1&key=<用户key>     //搜索存储在云图数据表中的北京市的写字楼,返回第一页数据
  • 示例返回结果
{
  "info": "OK",
  "status": 1,
  "count": 2,
  "datas": [
   {
    "_id": "295",
    "_name": "方恒国际",
    "_location": "116.481471, 39.990471",
    "_address": "北京市朝阳区阜通东大街18号",
    "star": 4,
    "rent":7.5,
    "_createtime": "2013-12-19 17:23:44",
    "_updatetime": "2013-12-19 17:23:44",
    "_province": "北京市",
    "_city": "北京市",
    "_district": "朝阳区"
   },
  {
    "_id": "355",
    "_name": "国际竹藤大厦",
    "_location": "116.479894, 39.988999 ",
    "_address": "北京市朝阳区望京阜通东大街8号",
    "star": 4,
    "rent":7,
    "_createtime": "2013-12-19 17:19:05",
    "_updatetime": "2013-12-19 17:19:05",
    "_province": "北京市",
    "_city": "北京市",
    "_district": "朝阳区"
  ]
}

周边检索

在指定table id的数据表内,搜索指定中心点和半径范围内,符合筛选条件的位置数据。服务协议:HTTP/HTTPS GET。

  • 周边检索请求

周边检索请求地址:

http://yuntuapi.amap.com/datasearch/around? parameters

parameters 表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

下面的列表枚举了这些参数及其可能的值。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

搜索关键词,支持0-9数字,大小写字母(a-z,A-Z)以及所有中文字符

点击查看:keywords对应的文本索引详解

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和_address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值;

5. city=城市名&keywords= (空格)或者是关键字,将返回对应城市的全部数据或对应关键字的数据;

6. 一次请求最多返回2000条数据。

可选

center

中心点坐标

规则:经度和纬度用","分割

经纬度小数点后不得超过6位。

必填

radius

查询半径

规则:取值范围[0,50000],单位:米。若超出取值范围按默认值

可选

3000

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解

筛选条件:

支持对建立了排序筛选索引的字段进行筛选(请在数据管理台中为字段建立排序筛选索引)

系统默认为:_id,_name,_address,_updatetime,_createtime建立排序筛选索引,其中_updatetime,_createtime暂时只支持排序);

支持多个筛选条件,多个筛选条件之间使用“+”代表与关系;

支持对文本字段的精确匹配;

支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sortrule

排序规则

点击查看:sortrule对应的筛选排序索引详解

1、支持按系统预设的:

_distance:坐标与中心点距离排序(仅支持升序sortrule=_distance:1);

_weight:权重排序(仅支持降序sortrule=_ weight:0);

示例:按距离排序

sortrule=_distance

2、支持按建立了排序筛选索引的整数或小数字段进行排序(请在数据管理台中管理排序筛选索引)

sortrule=字段名:1 (升序);

sortrule=字段名:0 (降序);

若不填升降序,则默认按升序排列。

示例:

按年龄age字段升序排序

sortrule=age:1

可选

1、当keywords存在时:默认按_weight权重排序;

2、当keywords不存在时,默认按_distance距离排序;

limit

每页记录数

最大每页记录数为100

可选

20

page

当前页数

>=1

可选

1

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

  • 返回结果字段说明

名称

含义

规则说明

是否必须返回

status

返回状态

值为0或1            

1:成功;            

0:失败

必填

info

返回的状态信息

status = 1,info返回“ok”

错误码说明

必填

count

返回结果总数目


必填

datas



必填


_id

数据id

数据唯一标识

必填

_name

数据名称

类型:string

必填

_location

坐标

支持点数据            

规则:经度,纬度,经纬度支持到小数点后6位

必填

_address

地址


必填

_province

所在省


必填

_city

所在市


必填

_district

所在区


必填,但当用户提供的地址信息不全时,可为空值

<customfield1>

用户自定义字段1



<customfield…>

用户自定义字段…



_createtime

创建时间


必填

_updatetime

更新时间


必填

_distance

距中心点距离


必填

_image

图片信息

类型:图片

选填,每个上传过图片的点,会返回


_id

图片id的标识




_preurl

经过压缩处理的图片地址

尺寸400*400,若期望获取体积较小的图片文件,建议使用此地址



_url

大图片的地址

最大限制获取1024*1024,若您的原始图片小于该尺寸,将返回原图。



  • 请求示例
http://yuntuapi.amap.com/datasearch/around?tableid=52b155b6e4b0bc61deeb7629&keywords=阜通东大街&<br>center=116.481471,39.990471&radius=500&filter=type:写字楼&limit=10&page=1<br>&key=<用户key>
  • 示例返回结果
{
  "info": "OK",
  "status": 1,
  "count": 2,
  "datas": [
   {
    "_id": "295",
    "_name": "方恒国际",
    "_location": "116.481471, 39.990471",
    "_address": "北京市朝阳区阜通东大街18号",
    "star": 4,
    "rent":7.5,
    "_createtime": "2013-12-19 17:23:44",
    "_updatetime": "2013-12-19 17:23:44",
    "_distance": 0 ,
    "_province": "北京市",
    "_city": "北京市",
    "_district": "朝阳区"
   },
  {
    "_id": "355",
    "_name": "国际竹藤大厦",
    "_location": "116.479894, 39.988999 ",
    "_address": "北京市朝阳区望京阜通东大街8号",
    "star": 4,
    "rent":7,
    "_createtime": "2013-12-19 17:19:05",
    "_updatetime": "2013-12-19 17:19:05",
    "_distance": 34,
    "_province": "北京市",
    "_city": "北京市",
    "_district": "朝阳区"
}
  ]
}

多边形检索

在指定tableid的数据表内,搜索指定多边形范围内、符合筛选条件的位置数据。服务协议:HTTP/HTTPS GET。

  • 多边形检索请求

多边形检索请求地址:

http://yuntuapi.amap.com/datasearch/polygon? parameters

parameters表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

下面的列表枚举了这些参数及其可能的值。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

数据表唯一标识

点击查看:keywords对应的文本索引详解

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和_address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值;

5. city=城市名&keywords= (空格)或者是关键字,将返回对应城市的全部数据或对应关键字的数据;

6. 一次请求最多返回2000条数据。

可选

polygon

中心点坐标

规则:                 逗号分隔的一对经纬度代表一个坐标,用分号分割多个坐标;

如果只传两个坐标则认为这两坐标为矩形的左下和右上点;

多边形数据的起点和终点必须相同,保证图形闭合。

示例:

- 矩形:

polygon=116.374634,39.377362;116.673646,39.576462

- 多边形:

polygon=115.7409668,40.12009038;115.59127808,39.98869502;115.8631897, 39.91816285;115.92224121,40.06546068;115.7409668,40.12009038

必填

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解

筛选条件:

支持对建立了排序筛选索引的字段进行筛选(请在数据管理台中为字段建立排序筛选索引);

系统默认为:_id,_name,_address,_updatetime,_createtime建立排序筛选索引,其中_updatetime,_createtime暂时只支持排序);

支持多个筛选条件,多个筛选条件之间使用“+”代表与关系;

支持对文本字段的精确匹配;

支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sortrule

排序规则

点击查看:filter对应的筛选排序索引的详解

1、支持按系统预设的:

_weight:权重排序(仅支持降序sortrule=_ weight:0);

2、支持按建立了排序筛选索引的整数或小数字段进行排序(请在数据管理台中管理排序筛选索引)

sortrule=字段名:1 (升序);

sortrule=字段名:0 (降序);

若不填升降序,则默认按升序排列。

示例:按年龄age字段升序排序

sortrule=age:1

可选

_weight

limit

每页记录数

最大每页记录数为100

可选

20

page

当前页数

>=1

可选

1

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

返回结果字段说明

名称

含义

规则说明

是否必须返回

status

返回状态

值为0或1            

1:成功;            

0:失败

必填

info

返回的状态信息

status = 1,info返回“ok”

错误码说明

必填

count

返回结果总数目


必填

datas



必填


_id

数据id

数据唯一标识

必填

_name

数据名称

类型:string

必填

_location

坐标

支持点数据            

规则:经度,纬度,经纬度支持到小数点后6位

必填

_address

地址


必填

_province

所在省


必填

_city

所在市


必填

_district

所在区


必填,但当用户提供的地址信息不全时,可为空值

<customfield1>

用户自定义字段1



<customfield…>

用户自定义字段…



_createtime

创建时间


必填

_updatetime

更新时间


必填

_image

图片信息

类型:图片

选填,每个上传过图片的点,会返回


_id

图片id的标识




_preurl

经过压缩处理的图片地址

尺寸400*400,若期望获取体积较小的图片文件,建议使用此地址



_url

大图片的地址

最大限制获取1024*1024,若您的原始图片小于该尺寸,将返回原图。



  • 请求示例
http://yuntuapi.amap.com/datasearch/polygon?tableid=52b155b6e4b0bc61deeb7629&keywords=<br>阜通东大街&polygon=116.464634,39.377362;116.493646,39.995462&filter=type:写字楼<br>&sortrule=rating:0&limit=10&page=1&key= < 用户key>
  • 示例返回结果
{
    "info": "OK", 
    "status": 1, 
    "count": 2, 
    "datas": [{
        "_id"        : "3554",
        "_name"      : "国际竹藤大厦",
        "_location"  : "116.479894, 39.988999 ",
        "_address"   : "北京市朝阳区望京阜通东大街8号",
        "star"       : 4,
        "rent"       : 7,
        "_createtime": "2013-12-19 17:19:05",
        "_updatetime": "2013-12-19 17:19:05",
        "_province"  : "北京市",
        "_city"      : "北京市",
        "_district"  : "朝阳区"
    }, {
        "_id"        : "295",
        "_name"      : "方恒国际",
        "_location"  : "116.481471, 39.990471",
        "_address"   : "北京市朝阳区阜通东大街18号",
        "star"       : 4,
        "rent"       : 7.5,
        "_createtime": "2013-12-19 17:23:44",
        "_updatetime": "2013-12-19 17:23:44",
        "_province"  : "北京市",
        "_city"      : "北京市",
        "_district"  : "朝阳区"
    }]
}

id检索(poi详情检索)

在指定table id的数据表内,查询对应数据id的数据详情。服务协议:HTTP/HTTPS GET。

  • id检索请求

id检索请求地址:

http://yuntuapi.amap.com/datasearch/id? parameters

parameters表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

下面的列表枚举了这些参数及其可能的值。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

_id

数据id


必填

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

返回结果字段说明

名称

含义

规则说明

是否必须返回

status

返回状态

值为0或1            

1:成功;            

0:失败

必填

info

返回的状态信息

status = 1,info返回“ok”

错误码说明

必填

count

返回结果总数目


必填

datas



必填


_id

数据id

数据唯一标识

必填

_name

数据名称

类型:string

必填

_location

坐标

支持点数据            

规则:经度,纬度,经纬度支持到小数点后6位

必填

_address

地址


必填

_province

所在省


必填

_city

所在市


必填

_district

所在区


必填,但当用户提供的地址信息不全时,可为空值

<customfield1>

用户自定义字段1



<customfield…>

用户自定义字段…



_createtime

创建时间


必填

_updatetime

更新时间


必填

_image

图片信息

类型:图片

选填,每个上传过图片的点,会返回


_id

图片id的标识




_preurl

经过压缩处理的图片地址

尺寸400*400,若期望获取体积较小的图片文件,建议使用此地址



_url

大图片的地址

最大限制获取1024*1024,若您的原始图片小于该尺寸,将返回原图。



  • 请求示例
http://yuntuapi.amap.com/datasearch/id?tableid=52b155b6e4b0bc61deeb7629&_id=372<br>&key= < 用户 key>
  • 示例返回结果
{
    "info": "OK", 
    "status": 1, 
    "count": 1, 
    "datas": [{
        "_id"        : "372",
        "_name"      : "国际竹藤大厦",
        "_location"  : "116.479894, 39.988999",
        "_address"   : "北京市朝阳区望京阜通东大街8号",
        "star"       : 4,
        "rent"       : 7,
        "_createtime": "2013-12-19 17:19:05",
        "_updatetime": "2013-12-19 17:19:05",
        "_province"  : "北京市",
        "_city"      : "北京市",
        "_district"  : "朝阳区"
    }]
}

按条件检索数据(可遍历整表数据)

根据筛选条件检索指定tableid数据表中的数据,返回JSON数据。

1) 检索存储在云图某个tableid的所有数据: 当检索条件不包含filter参数,即可检索出存储在云图的所有数据。

2) 按条件检索存储在云图某个tableid的数据: 通过设置filter参数,可按条件检索出存储在云图的数据。

按照limit,page设定的值分页展现。sortrule用以设定检索结果的排序规则。

服务协议:HTTP/HTTPS GET。

说明:启用该接口时,key的设置请开启云存储功能。具体方法:我的控制台-申请Web服务API类型KEY-开启云存储。

  • 条件查询请求

条件查询请求地址:

http://yuntuapi.amap.com/datamanage/data/list?parameters

parameters代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

下面的列表枚举了这些参数及其可能的值。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

filter

筛选条件

点击查看:filter对应的筛选排序索引的详解

筛选条件:

支持多个筛选条件,多个筛选条件之间使用“+”代表与关系。

支持对文本字段的精确筛选;

支持对数值字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

( 等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5 )

可选

sortrule

排序方式

点击查看:sortrule对应的筛选排序索引的详解

支持按用户自选的字段(仅支持数值类型字段)升降序排序。1:升序,0:降序

若不填升降序,默认按升序排列。

示例:按年龄age字段升序排序

sortrule = age:1

可选

id:0

limit

每页记录数

规则:每页最大记录数为100

可选

20

page

当前页数

>=1

可选

1

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

  • 请求示例
http://yuntuapi.amap.com/datamanage/data/list?tableid=52b155b6e4b0bc61deeb7629&filter=_name:颐和园+type:公园&limit=10&page=1&key= <用户key>
  • 条件查询响应

结果示例

{
    "info": "OK",
    "status": 1,
    "count": 2,
    "datas": [
    {
        "_id": "4",
        "_name": "北京港澳中心瑞士酒店",
        "_location": "116.44193,39.9342",
        "_address": "北京市东城区朝阳门北大街2号",
        "star": 5,
        "rent":8,
        "_createtime": "2013-12-19 17:19:05",
        "_updatetime": "2013-12-19 17:19:05",
        "_locstatus": 1

    },
    {
        "_id": "27",
        "_name": "方恒国际",
        "_location": "116.479894, 39.988999",
        "_address": "北京市朝阳区阜通东大街18号",
        "star": 4,
        "rent":7.5,
        "_createtime": "2013-12-19 17:23:44",
        "_updatetime": "2013-12-19 17:23:44",
        "_locstatus": 1
    },
] }

返回结果字段说明

名称

含义

规则说明

是否必须返回

status

返回状态

值为0或1            

1:成功;            

0:失败

必填

info

返回的状态信息

status = 1,info返回“ok”

错误码说明

必填

count

返回结果总数目


必填

datas



必填


_id

数据id

数据唯一标识

必填

_name

数据名称

类型:string

必填

_location

坐标

支持点数据            

规则:经度,纬度,经纬度支持到小数点后6位

必填

_address

地址


必填

_province

所在省


必填

_city

所在市


必填

_district

所在区


必填,但当用户提供的地址信息不全时,可为空值

<customfield1>

用户自定义字段1



<customfield…>

用户自定义字段…



_createtime

创建时间


必填

_updatetime

更新时间


必填

_image

图片信息

类型:图片

选填,每个上传过图片的点,会返回


_id

图片id的标识




_preurl

经过压缩处理的图片地址

尺寸400*400,若期望获取体积较小的图片文件,建议使用此地址



_url

大图片的地址

最大限制获取1024*1024,若您的原始图片小于该尺寸,将返回原图。



数据分布检索

数据分布检索是指按照行政区划对数据分布情况进行统计检索。检索指定云图tableid里全表数据或按照一定查询或筛选过滤,返回行政区划(省、市、区县)名称(中文名称)和对应POI个数(count)的信息列表。数据分布检索细分为三个接口:省数据分布检索、市数据分布检索、区县数据分布检索。

(1)省数据分布检索

本检索是指检索指定云图tableid里,全表数据或按照一定查询或筛选过滤而返回的数据中,含有数据的省名称(中文名称)和对应POI个数(count)的信息列表,按照count从高到低的排序展现,返回json数据。例如:检索在云图里某个Tableid里的“中国(country)”各省的“医院(keywords     )”个数。keywords是对建立了文本索引字段的对应列内容进行关键字查询;filter是对建立筛选排序索引字段的对应列内容进行筛选,请在数据管理台完成文本/筛选排序字段索引字段的添加或删除。

服务协议:HTTP/HTTPS GET。 

  • 省数据分布检索请求

省数据分布检索请求地址:

http://yuntuapi.amap.com/datasearch/statistics/province?parameters

parameters 表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

搜索关键词,支持0-9数字,大小写字母(a-z,A-Z)以及所有中文字符

点击查看:keywords对应的文本索引详解  

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和                  _address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;  

如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工                  商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关                  键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招                  商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包                  含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值。

必填

country

指定所需查询的国家名(目前仅支持中国)

country = 中国

可选

中国

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解  

筛选条件:

1.对建立【排序筛选索引字段】进行检索;

2. 请在数据管理台添加或删除筛选排序索引字段,系统默认为_id,_name,_address,_updatetime,_createtime(其中updatetime,_createtime暂只能用于排序,不能作为过滤字段)

3. 支持多个筛选条件并行使用:多个过滤条件之间使用“+”(代表与关系);

4. 支持对文本类型的字段进行精确匹配;

5. 支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sig

数字签名

数字签名获取和使用方法

选择数字签名认证

的用户必填

callback

回调函数

类型:string

js回调函数

可选

返回结果字段说明

名称

含义

规则说明

是否必须返回

datas



必填


name

省名称

类型:string

必填

count

该省份对应的POI个数


必填

  • 请求示例
http://yuntuapi.amap.com/datasearch/statistics/province?tableid=52b155b6e4b0bc61deeb7629&country=中国&keywords= &filter=type:研究机构&key=<用户key>     //搜索存储在云图数据表中的全国个身份的研究机构个数
  • 示例返回结果
{
    "info": "OK",
    "status": 1,
    "datas": [
        {
            "name": "新疆维吾尔自治区",
            "count": "2"
        },
        {
            "name": "甘肃省",
            "count": "4"
        },
        {
            "name": "陕西省",
            "count": "7"
        }
    ]
}

(2)市数据分布检索

本检索是指检索指定云图tableid里,全表数据或按照一定查询或筛选过滤而返回的数据中,含有数据的市名称(中文名称)和对应POI个数(count)的信息列表,按照count从高到低的排序展现,返回json数据。例如:检索在云图里某个Tableid里的“山东省(province)”各市的“医院(keywords     )”个数。keywords是对建立了文本索引字段的对应列内容进行关键字查询;filter是对建立筛选排序索引字段的对应列内容进行筛选,请在数据管理台完成文本/筛选排序字段索引字段的添加或删除。

服务协议:HTTP/HTTPS GET。

  • 市数据分布检索请求

市数据分布检索请求地址:

http://yuntuapi.amap.com/datasearch/statistics/city?parameters

parameters 表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

搜索关键词,支持0-9数字,大小写字母(a-z,A-Z)以及所有中文字符

点击查看:keywords对应的文本索引详解  

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和                  _address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;                  如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工                  商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关                  键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招                  商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包                  含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值。

必填

province

指定所需查询的省

规则: 省中文名称;

说明:

1. province = 全国,返回含有数据的所有市名称以及对应数据量,并根据数据量从高到低排行;

2. province = 山东,返回沈阳含有数据的所有市名称以及对应数据量,并根据数据量从高到低排行;

可选

全国

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解  

筛选条件:

1.对建立【排序筛选索引字段】进行检索;

2. 请在数据管理台添加或删除筛选排序索引字                  段,系统默认为_id,_name,_address,_updatetime,_createtime(其中                  _updatetime,_createtime暂只能用于排序,不能作为过滤字段)

3. 支持多个筛选条件并行使用:多个过滤条件之间使用“+”(代表与关系);

4. 支持对文本类型的字段进行精确匹配;

5. 支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

callback

回调函数

类型:string

js回调函数

可选

返回结果字段说明

名称

含义

规则说明

是否必须返回

datas



必填


name

市名称

类型:string

必填

count

该市对应的POI个数


必填

  • 请求示例
http://yuntuapi.amap.com/datasearch/statistics/city?tableid=52b155b6e4b0bc61deeb7629&province=山东省&keywords= &filter=type:研究机构&key=<用户key>     //搜索存储在云图数据表中的山东省各市的研究机构个数
  • 示例返回结果
{
    "info": "OK",
    "status": 1,
    "datas": [
        {
            "name": "菏泽市",
            "count": "9"
        },
        {
            "name": "潍坊市",
            "count": "6"
        },
        {
            "name": "聊城市",
            "count": "5"
        },
        {
            "name": "临沂市",
            "count": "4"
        },
        {
            "name": "济宁市",
            "count": "4"
        },
        {
            "name": "威海市",
            "count": "3"
        },
        {
            "name": "莱芜市",
            "count": "3"
        }
    ]
}

(3)区县数据分布检索

本检索是指检索指定云图tableid里,在指定的省,市下面全表数据或按照一定查询或筛选过滤而返回的数据中,所有区县名称(中文名称)和对应POI个数(count)的信息列表,按照count从高到低的排序展现,返回json数据。例如:检索在云图里某个tableid里的“山东省(province)”,“临沂市(city)”各区县的“学校(keywords)”个数。keywords是对建立了文本索引字段的对应列内容进行关键字查询;filter是对建立筛选排序索引字段的对应列内容进行筛选,请在数据管理台完成文本/筛选排序字段索引字段的添加或删除。

服务协议:HTTP/HTTPS GET。

  • 区县数据分布检索请求

区县数据分布检索请求地址:

http://yuntuapi.amap.com/datasearch/statistics/district?parameters

parameters 表示:必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。

  • 请求参数

名称

含义

规则说明

是否必须

缺省值

key

客户唯一标识

用户申请,由高德地图API后台自动分配

必填

table id

数据表唯一标识

获取table id方法

必填

keywords

搜索关键词,支持0-9数字,大小写字母(a-z,A-Z)以及所有中文字符

点击查看:keywords对应的文本索引详解  

1. 请先在云图数据管理台添加或删除文本索引字段,系统默认为_name和_address建立文本索引;

2. 支持关键字模糊检索,即对建立【文本索引字段】对应列内容进行模糊检索;如keywords=工商银行,检索返回已建立文本索引列值中包含“工商”或者“银行”或者“工商银行”关键字的POI结果集。

3. 支持关键字“或”精准检索,即对建立【文本索引字段】对应列内容进行多关键字检索;如keywords=招商银行|华夏银行|工商银行,检索返回已建立索引列值中包含“招商银行”或者“华夏银行”或者“工商银行”的POI结果集,不会返回检索词切分后,如仅包含“招商”或者“银行”的POI集。

4. 可赋值为空值,用空格表示空值。

必填

province

指定所需查询的省

规则: 省中文名称;

必填

city

指定所需查询的市

规则:市的中文名称;

说明:

city = 城市名称,返回该市下,各区县名称以及对应数据量,并根据数据量从高到低排行;

必填

filter

过滤条件

点击查看:filter对应的筛选排序索引的详解  

筛选条件:

1.对建立【排序筛选索引字段】进行检索;

2. 请在数据管理台添加或删除筛选排序索引字段,系统默认为_id,_name,_address,_updatetime,_createtime(其中_updatetime,_createtime暂只能用于排序,不能作为过滤字段)

3. 支持多个筛选条件并行使用:多个过滤条件之间使用“+”(代表与关系);

4. 支持对文本类型的字段进行精确匹配;

5. 支持对整数和小数字段的连续区间筛选。

规则:

filter=key1:value1+key2:[value2,value3]

示例:

filter=type:酒店+star:[3,5]

(等同于SQL语句的:

WHERE type = "酒店"

AND star BETWEEN 3 AND 5)

可选

sig

数字签名

数字签名获取和使用方法

选择数字签名认证的用户必填

callback

回调函数

类型:string

js回调函数

可选

返回结果字段说明

名称

含义

规则说明

是否必须返回

datas



必填


name

区县名称

类型:string

必填

count

该区县对应的POI个数


必填

  • 请求示例
http://yuntuapi.amap.com/datasearch/statistics/city?tableid=52b155b6e4b0bc61deeb7629&province=山东省&city=临沂市&keywords= &filter=type:中学&key=<用户key>     //搜索存储在云图数据表中的山东省临沂市各区县的中学个数
  • 示例返回结果
{
    "info": "OK",
    "status": 1,
    "datas": [
        {
            "name": "沂水县",
            "count": "4"
        },
        {
            "name": "兰山区",
            "count": "0"
        },
        {
            "name": "罗庄区",
            "count": "0"
        },
        {
            "name": "河东区",
            "count": "0"
        },
        {
            "name": "沂南县",
            "count": "0"
        },
        {
            "name": "郯城县",
            "count": "0"
        },
        {
            "name": "兰陵县",
            "count": "0"
        },
        {
            "name": "费县",
            "count": "0"
        },
        {
            "name": "平邑县",
            "count": "0"
        },
        {
            "name": "莒南县",
            "count": "0"
        },
        {
            "name": "蒙阴县",
            "count": "0"
        },
        {
            "name": "临沭县",
            "count": "0"
        }
    ]
}

错误码说明

stauts(请求状态码)

info(状态码对应说明)

0(请求失败)

info值枚举如下:

tableid不存在

_id不存在

服务器维护中

参数缺失或格式非法

账号未激活或已被冻结

UNKNOWN_ERROR:code (code = -101~-404之间,表示云图服务内部错误;code = -41,表示key和tableid不在同一高德用户账户下,无权访问)

SERVICE_NOT_EXIST (表示:请求的服务不存在)

IN VALID_USER_KEY(表示:key无效)

USER_VISIT_TOO_FREQUENTLY (表示:用户访问过于频繁,服务不响应)

NOT_SUPPORT_HTTPS (表示:不支持HTTPS请求)

INVALID_USER_IP (表示:用户IP无效)

INVALID_USER_SIGNATURE (表示:该服务响应错误)

INVALID_USER_SCode (表示:用户安全码未通过)

未知错误 (以上错误之外的未定义的错误)

注意事项 

  • API服务密钥:高德云图存储API使用API密钥来标识用户的应用。服务请求url中的 key 参数为必填参数,需要填入此密钥。所以使用接口前请 获取Key ,若无高德地图API账号需要先申请账号
  • 编码格式:如无特殊声明,接口的输入参数和输出数据编码全部统一为UTF-8。
移动端
示例中心
功能
在线体验
常见问题