阿里云-开放搜索服务API参考手册-D

《阿里云-开放搜索服务API参考手册-D》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、开放搜索API参考手册开放搜索/API参考手册API参考手册API概览系统为开发者提了一套REST风格的WebAPI服务。本手册将详细介绍WebAPI的功能、使用方法及详细参数的设定。API说明文档：包括应用相关API，上传数据API，数据搜索API。API访问上分为公共参数及请求参数两部分，所有请求均必须包含该两部分才能执行。术语表术语全称中文说明appapplication应用一个应用即一个完整的搜索服务错误码API描述错误码返回错误码说明公共调用方式API描述公共参数公共调用及返回参数说明授权机制详细说明验签过程应用操作接口API描述应用管理创建、修

2、改、删除、查看应用数据处理上传、修改、删除文档搜索查询50表格存储/API参考手册错误信息查看错误日志索引重建创建、查看索引重建任务配额管理修改、查看配额信息更新历史-API版本：V2发布时间更新说明当前状态2014-01-01发布V2版本，优化使用接口，提高查询性能stable2013-01-01发布V1版本，提供主流系统操作api接口不维护状态，尽快升级V2-最近更新时间：2014-01-01调用方式请求结构服务地址OpenSearch为分区域部署，每个区域访问地址均不同，具体服务地址请查看访问应用-》基本详情中的API入口部分获取，切勿随便使用。通信

3、协议支持HTTP协议请求方法推送数据建议采用POST方式，搜索建议采用GET方式。注意：使用POST方式向API提交数据时需要将HTTP请求的"Content-Type"设置为"application/x-www-form-urlencoded"，否则会导致API解析失败。50数据传输/最佳实践请求参数每个操作都需要包含公共请求参数及具体请求所特有的请求参数。字符编码请求及返回结果都仅支持UTF-8字符集。公共调用方式公共请求参数公共请求参数是指每个接口都需要使用到的请求参数。名称类型是否必须描述VersionString是API版本，当前版本为：v2Ac

4、cessKeyIdString是阿里云颁发给用户的访问服务所用的密钥IDSignatureString是签名结果串，关于签名的计算方法，请参见授权机制。SignatureMethodString是签名方式，目前支持HMAC-SHA1TimestampString是请求的时间戳。日期格式按照ISO8601标准表示，必须使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ例如，2014-05-26T12:00:00Z（为北京时间2014年5月26日20点0分0秒）SignatureVersionString是签名算法版本，目前版本是1.0Signat

5、ureNonceString是唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值，建议使用13位毫秒时间戳+4位随机数50数据传输/最佳实践http://$host/index/doc/$app_name?Version=v2&AccessKeyId=$accessKeyId&Signature=$signature&SignatureMethod=HMAC-SHA1&Timestamp=$timestamp&SignatureVersion=1.0&SignatureNonce=$signatureNonce示例公共返回结果用户发送的

6、每次接口调用请求，无论成功与否，系统都会返回一个status字段给用户，用来表示本次请求的正确与否。同时，错误的请求将会返回错误代码及错误描述，供用户调试。请求结束后请务必检查返回值是否正常，并根据错误信息及时修改，否则可能出现数据丢失或者请求无结果的情况。示例JSON示例{"status":"OK"}返回成功：返回错误：{"status":"FAIL","errors":[{"code":2001,"message":"Appisnotfound"}]}授权机制OpenSearch服务会对每个访问的请求进行身份验证，通过使用AccessKeyID和Acc

7、essKeySecret进行对称加密的方法来验证请求的发送者身份。AccessKeyID和AccessKeySecret由阿里云官方颁发给访问者（可以通过阿里云官方网站申请和管理），其中AccessKeyID用于标识访问者的身份；AccessKeySecret是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有阿里云和用户知道。签名步骤50数据传输/最佳实践1.使用请求参数构造规范化的请求字符串（CanonicalizedQueryString）注：当使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即URI中"?"之后由"&

8、"连接的部分）；a.按照参数名称的字典顺序对请求中所有的请求参数（