示例中心
功能在线体验
控制台

高德 开发 云图服务API 开发指南 实用工具 API参数详解

更新时间:2017年02月09日

API参数详解

云存储API和云检索API中,tableid,keywords,filter,sortrule参数详细说明如下。

1. 地图的标识码(tableid)

您所创建的每个地图的唯一标识符,由24位的字母和数字组成的字符串。

您使用云图API或SDK开发时,必填参数,用以识别您需要对哪一个创建的地图进行存储和检索操作。

两种获取方法:

第一种:API获取: 您使用云存储API - 创建表API(等同于数据管理台创建地图操作)- 返回结果参数(包含tableid)

第二种:云图数据管理台:登录云图数据管理台,打开创建的地图,获取方法如下。

yuntu_tableid


2. 文本索引(keywords)

云检索API的keywords参数能进行有效搜索的必须条件。

a. 云检索API中keywords参数: 仅对建立【文本索引】的字段列内容,进行关键词(keywords)的搜索;云图默认为系统内置字段_name,_address建立文本索引,若需更多,自行添加文本索引,实时生效。

b. 添加文本索引:可对 【列属性 – 列类型 – 字符串】类型的字段列添加索引。需在云图数据管理台完成操作。

yuntu_column


c. 添加文本索引步骤:

第一步: 登录云图数据管理台

第二步: 打开您所创建的地图;

第三步: 如下图,建立文本索引。

yuntu_keywords


3.  筛选排序索引(filter,sortrule)

云检索API中的筛选filter和排序sortrule参数能有效进行过滤的必须条件。

a. 云检索API中的filter,sortrule参数:仅对【筛选排序索引】的字段列内容,进行filter过滤以及sortrule排序;

云图默认为系统字段_id,_name,_address,_createtime,_updatetime建立筛选排序索引,其中_createtime,_updatetime仅能排序,若需更多,自行添加筛选排序索引,实时生效。

b. 添加筛选排序索引:可对目前云图数据管理台开放的【列属性-列类型】的任意类型的字段列筛选排序索引。需在云图数据管理台完成操作。

c. 添加筛选排序索引步骤:

第一步: 登录云图数据管理台;

第二步: 打开您所创建的地图;

第三步: 如下图,建立筛选排序索引。

yuntu_fitle_sort


移动端
示例中心
功能
在线体验
常见问题