ElasticSearch连接器-通用模板是介绍如果利用elastic连接器创建接口
接口地址:http://route.showapi.com/2161-1 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。
二、请求参数/ Request parameter
非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述 showapi_appid String 100 是 易源应用id showapi_sign String 698d51a19d8a121ce581499d7b701668 是 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 showapi_timestamp String 20141114142239 否 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。showapi_res_gzip String 1或0 否 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 ... 2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述 query String name:张三 是 查询的条件,可以使用*查询所有数据;key:value查询field为key,值为value的数据;多个kv条件,请使用json查询,如查询人名为张三,年纪为26岁的人,则该参数的值: {"name":"张三","age":26} . 需要注意的是要么是查询所有的数据,即用*查询,要么就只能用k=v的方式查询.如果是使用age>26的方式,请参考使用"执行ES语句"功能. page String 1 1 否 分页查询的当前页数 op_type String AND OR 否 多个查询条件时,各条件之间的关系,取值是AND或者OR. AND表示多个条件都满足要求,OR表示只要满足其中一个条件 maxResult String 10 5 否 每页最多能查到的记录数,当总条数大于一定的值时,本查询会出错,需要配置您的ElasticSearch的index.max_result_window参数. sort String age:asc 否 格式:field_name:asc/desc indexName String common_index 否 需要查询的index,如果不填写该字段,则使用数据源中配置的默认index ...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/2161-1","my_appId","my_appSecret") .addTextPara("query","name:张三") .addTextPara("page","1") .addTextPara("op_type","OR") .addTextPara("maxResult","5") .addTextPara("sort","age:asc") .addTextPara("indexName","common_index") .post(); System.out.println(res);
三、返回参数/ Return parameter
以JSON格式返回结果。
1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述 showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 showapi_res_code int 0 易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示 showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id ... 2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述 allPages Number 2 总页数 maxResult Number 10 每页返回的最大数据条数 remark String 查询成功。 操作提示 currentPage Number 1 当前页码 ret_code Number 0 操作编码,0表示成功,其他为失败. contentlist Object[] 您要查询的数据列表 allNum String 20 数据总条数 ...
返回示例:{
"showapi_res_id": "",
"showapi_res_error": "",
"showapi_res_code": 0,
"showapi_res_body": {
"ret_code": 0,
"allPages": 2,
"maxResult": 10,
"remark": "查询成功。",
"contentlist":[
{
"name": "王刘2",
"_id": "7",
"addr": ["中国湖北xx","云南昆明..."],
"age": 32
},
{
"name": "王刘3",
"_id": "8",
"addr": ["中国北京王府井","湖南长沙洪山路"],
"age": 33
}
],
"currentPage": 1,
"allNum": "20"
}
}
接口地址:http://route.showapi.com/2161-2 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。
二、请求参数/ Request parameter
非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述 showapi_appid String 100 是 易源应用id showapi_sign String 698d51a19d8a121ce581499d7b701668 是 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 showapi_timestamp String 20141114142239 否 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。showapi_res_gzip String 1或0 否 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 ... 2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述 data String {"id_card":"532120199001010000","name":"my_name","age":33}是 插入的数据,要求是json结构的id_field String id_card否 指定数据的唯一标识,该标识是data中json结构的第一层里的某个字段名id String 12否 为数据直接指定唯一标识,当该参数与id_field一起使用时,以id参数为准indexName String common_index否 把数据保存到指定的索引下,不填写此参数则使用数据源中配置的默认index...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/2161-2","my_appId","my_appSecret") .addTextPara("data","{\"id_card\":\"532120199001010000\",\"name\":\"my_name\",\"age\":33}") .addTextPara("id_field","id_card") .addTextPara("id","12") .addTextPara("indexName","common_index") .post(); System.out.println(res);
三、返回参数/ Return parameter
以JSON格式返回结果。
1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述 showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 showapi_res_code int 0 易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示 showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id ... 2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述 result String created 是创建created还是更新updated_shards String {"total":2,"failed":0,"successful":1} 当前分片查询的情况,仅供参考,可忽略_seq_no Number 7 创建数据的序号,仅供参考,可忽略remark String 操作成功。_version String 1 版本号,也可以认为是该条数据创建或更新操作的次数_primary_term String 5 Primary选举次数,仅供参考,可忽略ret_code Number 0 操作编码,为0时表示操作成功,其他值为失败...
返回示例:{
"showapi_res_id": "",
"showapi_res_error": "",
"showapi_res_code": 0,
"showapi_res_body":{
"result":"created",
"_shards":{"total":2,"failed":0,"successful":1},
"_seq_no":7,
"remark":"操作成功。",
"_id":"9",
"_version":1,
"_primary_term":5,
"ret_code":0
}
}
接口地址:http://route.showapi.com/2161-3 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。
二、请求参数/ Request parameter
非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述 showapi_appid String 100 是 易源应用id showapi_sign String 698d51a19d8a121ce581499d7b701668 是 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 showapi_timestamp String 20141114142239 否 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。showapi_res_gzip String 1或0 否 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 ... 2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述 id String 13是 要删除的数据的唯一标识indexName String common_index否 要操作的index,不填写就使用数据源中配置的默认index
请求示例:String res=new ShowApiRequest("http://route.showapi.com/2161-3","my_appId","my_appSecret") .addTextPara("id","13") .addTextPara("indexName","common_index") .post(); System.out.println(res);
三、返回参数/ Return parameter
以JSON格式返回结果。
1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述 showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 showapi_res_code int 0 易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示 showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id ... 2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述 ret_code String 0 操作返回的编码,0表示操作成功,其他值为失败remark String 操作成功。 操作提示...
返回示例:{
"showapi_res_id": "",
"showapi_res_error": "",
"showapi_res_code": 0,
"showapi_res_body": {
"ret_code": "0",
"remark": "操作成功。"
}
}
接口地址:http://route.showapi.com/2161-4 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。
二、请求参数/ Request parameter
非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述 showapi_appid String 100 是 易源应用id showapi_sign String 698d51a19d8a121ce581499d7b701668 是 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 showapi_timestamp String 20141114142239 否 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。showapi_res_gzip String 1或0 否 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 ... 2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述 exec_json String { "query": { "range": { "age": { "gte": 20, "lte": 40 } } } }否 需要执行的语句,要求是json结构的满足elastic语法的语句op_type String 1是 数据提交的方式,比如删除操作用3,具体取值如下: 1:get 2:post 3:delete 4:put 5:headurl String /common_index/_search是 调用的url地址,由于在配置数据源时,已经说明了elastic服务器的IP端口,所以此处无需配置host和port等信息...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/2161-4","my_appId","my_appSecret") .addTextPara("exec_json","{ \"query\": { \"range\": { \"age\": { \"gte\": 20, \"lte\": 40 } } } }") .addTextPara("op_type","1") .addTextPara("url","/common_index/_search") .post(); System.out.println(res);
三、返回参数/ Return parameter
以JSON格式返回结果。
1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述 showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 showapi_res_code int 0 易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示 showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id ... 2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述 ret_code Number 0 操作的错误码,0表示操作成功,其他值为失败remark String 操作已执行,结果请参考相应返回信息。 操作提示 操作返回的信息会根据操作请求的内容不同而不同,返回信息并不固定,需要您或您的开发人员对elastic有重复的了解,具体参数说明请参考elastic官方文档....
返回示例:{
"showapi_res_id": "",
"showapi_res_error": "",
"showapi_res_code": 0,
"showapi_res_body": {
"_shards":{"total":5,"failed":0,"successful":5,"skipped":0},
"hits":{"hits":["如果是查询操作,此处返回您查询的结果"],"total":2,"max_score":1.0},
"took":6,
"timed_out":false,
"remark":"操作已执行,结果请参考相应返回信息。",
"ret_code":0
}
}
接口地址:http://route.showapi.com/2161-5 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。
二、请求参数/ Request parameter
非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述 showapi_appid String 100 是 易源应用id showapi_sign String 698d51a19d8a121ce581499d7b701668 是 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 showapi_timestamp String 20141114142239 否 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。showapi_res_gzip String 1或0 否 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。 ... 2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述 sql String select name,age from common_index where age<40是 需要执行的sql语句.只有6.3以上版本的elasticSearch才支持该功能. elastic能支持的SQL请参考:https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-getting-started.html
请求示例:String res=new ShowApiRequest("http://route.showapi.com/2161-5","my_appId","my_appSecret") .addTextPara("sql","select name,age from common_index where age
三、返回参数/ Return parameter
以JSON格式返回结果。
1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述 showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。 showapi_res_code int 0 易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示 showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id ... 2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述 ret_code String 0 0表示操作成功,其他表示操作失败remark String 操作提示,其他参数的返回根据执行的语句不同返回的信息会不完全一致,需要了解elastic关于SQL的说明...
返回示例:{
"showapi_res_id": "",
"showapi_res_error": "",
"showapi_res_code": 0,
"showapi_res_body": {
"columns":[{"name":"name","type":"text"},{"name":"age","type":"long"}],
"remark":"操作已执行,结果请参考返回信息。",
"rows":[["王刘2",32],["王刘3",33]],
"ret_code": "0"
}
}
易源数据通过打破资源壁垒,搭建起数据资源的基础设施,将接口纳入统一的接口池,把多个异构数据源合并到同一根管线上,以统一的访问和控制方式,对外提供统一格式的数据。
让开发者可以像搭积木一样通过各种API操纵资源。
截至2017年12月,平台已经拥有API接口230个,日调用量2000万,覆盖全网10万+真实消费者,为超过3000+的企业用户提供全域数据服务。
电话: 4009988033
微博: http://www.weibo.com/showapi
邮箱: services@showapi.com
QQ: 3007663665
微信: show_api
企业和程序员可以通过进制数据封装的API或SDK极速接入其他数据资源,同时进制数据提供数据交易等服务。通过进制数据,不仅开发成本极大降低,而且可以获得其他丰富的数据服务:数据交易,数据分析,区块链Token管理等服务。
电话:173-6457-5198
QQ① 群:792473404
客服 QQ:1643296538
微信客服:binstds
扫描二维码添加客服微信
周一至周五 9:00 - 21:00(其中周三为 9:00 - 18:00)
周六 9:00 - 12:00(节假日除外)
进制数据团队
2020.01.01