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

开放搜索 API参考手册 开放搜索/API参考手册 开放搜索/API参考手册 PAGE 10 PAGE 10 API参考手册 API概览 系统为开发者提了一套REST风格的WebAPI服务。本手册将详细介绍WebAPI的功能、使用方法及详细参数的 设定。 API说明文档：包括应用相关API，上传数据API，数据搜索API。 API访问上分为公共参数及请求参数两部分，所有请求均必须包含该两部分才能执行。 术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码 返回错误码说明 公共调用方式 API 描述 公共参数 公共调用及返回参数说明 授权机制 详细说明验签过程 应用操作接口 API 描述 应用管理 创建、修改、删除、查看应用 数据处理 上传、修改、删除文档 搜索 查询 表格存储/API参考手册 表格存储/API参考手册 错误信息 查看错误日志 索引重建 创建、查看索引重建任务 配额管理 修改、查看配额信息 更新历史 - API版本：V2 发布时间更新说明当前状态 发布时间 更新说明 当前状态 2014-01-01 发布V2版本，优化使用接口 ，提高查询性能 stable 2013-01-01 发布V1版本，提供主流系统操作api接口 不维护状态，尽快升级V2 调用方式请求结构 服务地址 OpenSearch为分区域部署，每个区域访问地址均不同，具体服务地址请查看访问应用-》基本详情中的API入 口部分获取，切勿随便使用。 通信协议 支持HTTP协议 请求方法 推送数据建议采用POST方式，搜索建议采用GET方式。 注意：使用POST方式向API提交数据时需要将HTTP请求的Content-Type设置为application/x-www-form-urlencoded，否则会导致API解析失败。 数据传输/最佳实践 数据传输/最佳实践 请求参数 每个操作都需要包含公共请求参数及具体请求所特有的请求参数。 字符编码 请求及返回结果都仅支持UTF-8字符集。 公共调用方式 公共请求参数 公共请求参数是指每个接口都需要使用到的请求参数。 名称 类型 是否必须 描述 Version String 是 API 版本，当前版本为 ：v2 AccessKeyId String 是 阿里云颁发给用户的访问服务所用的密钥ID Signature String 是 签名结果串，关于签名的计算方法，请参见授权机制。 SignatureMethod String 是 签名方式，目前支持HMAC-SHA1 Timestamp String 是 请求的时间戳。日期格式按照ISO8601标准 表示，必须使用UTC时间 。 格 式 为 YYYY- MM-DDThh:mm:ssZ 例 如 ，2014-05- 26T12:00:00Z（为北 京时间2014年5月26日20点0分0秒） SignatureVersion String 是 签名算法版本，目前版本是1.0 SignatureNonce String 是 唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值，建议使用13位毫秒时间戳+4位随机数 http://$host/index/doc/$app_name?Version=v2AccessKeyId=$accessKeyIdSignature=$signatureSignatureMet hod=HMAC-SHA1Timestamp=$timestampSignatureVersion=1.0SignatureNonce=$signatureNonce http://$host/index/doc/$app_name?Version=v2AccessKeyId=$accessKeyIdSignature=$signatureSignatureMet hod=HMAC-SHA1Timestamp=$timestampSignatureVersion=1.0SignatureNonce=$signatureNonce 公共返回结果 用户发送的每次接口调用请求，无论成功与否，系统都会返回一个status字段给用户，用来表示本次请求的正 确与否。同时，错误的请求将会返回错误代码及错误描述，供用户调试。 请求结束后请务必检查返回值是否正常，并根据错误信息及时修改，否则可能出现数据丢失或者请求无结果的 情况。 示例 JSON示例 {status: OK { status: OK } 返回错误： { { status:FAIL, errors:[ {code:2001, message:App is not found} ] } 授权机制 OpenSearch服务