阿里云-開放搜索服務(wù)API參考手冊-D

《阿里云-開放搜索服務(wù)API參考手冊-D》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、開放搜索API參考手冊開放搜索/API參考手冊API參考手冊API概覽系統(tǒng)為開發(fā)者提了一套REST風(fēng)格的WebAPI服務(wù)。本手冊將詳細(xì)介紹WebAPI的功能、使用方法及詳細(xì)參數(shù)的設(shè)定。API說明文檔：包括應(yīng)用相關(guān)API，上傳數(shù)據(jù)API，數(shù)據(jù)搜索API。API訪問上分為公共參數(shù)及請求參數(shù)兩部分，所有請求均必須包含該兩部分才能執(zhí)行。術(shù)語表術(shù)語全稱中文說明appapplication應(yīng)用一個應(yīng)用即一個完整的搜索服務(wù)錯誤碼API描述錯誤碼返回錯誤碼說明公共調(diào)用方式API描述公共參數(shù)公共調(diào)用及返回參數(shù)說明授權(quán)機制詳細(xì)說明驗簽過程應(yīng)用操作接口API描述應(yīng)用管理創(chuàng)建、修

2、改、刪除、查看應(yīng)用數(shù)據(jù)處理上傳、修改、刪除文檔搜索查詢50表格存儲/API參考手冊錯誤信息查看錯誤日志索引重建創(chuàng)建、查看索引重建任務(wù)配額管理修改、查看配額信息更新歷史-API版本：V2發(fā)布時間更新說明當(dāng)前狀態(tài)2014-01-01發(fā)布V2版本，優(yōu)化使用接口，提高查詢性能stable2013-01-01發(fā)布V1版本，提供主流系統(tǒng)操作api接口不維護狀態(tài)，盡快升級V2-最近更新時間：2014-01-01調(diào)用方式請求結(jié)構(gòu)服務(wù)地址OpenSearch為分區(qū)域部署，每個區(qū)域訪問地址均不同，具體服務(wù)地址請查看訪問應(yīng)用-》基本詳情中的API入口部分獲取，切勿隨便使用。通信

3、協(xié)議支持HTTP協(xié)議請求方法推送數(shù)據(jù)建議采用POST方式，搜索建議采用GET方式。注意：使用POST方式向API提交數(shù)據(jù)時需要將HTTP請求的"Content-Type"設(shè)置為"application/x-www-form-urlencoded"，否則會導(dǎo)致API解析失敗。50數(shù)據(jù)傳輸/最佳實踐請求參數(shù)每個操作都需要包含公共請求參數(shù)及具體請求所特有的請求參數(shù)。字符編碼請求及返回結(jié)果都僅支持UTF-8字符集。公共調(diào)用方式公共請求參數(shù)公共請求參數(shù)是指每個接口都需要使用到的請求參數(shù)。名稱類型是否必須描述VersionString是API版本，當(dāng)前版本為：v2Ac

4、cessKeyIdString是阿里云頒發(fā)給用戶的訪問服務(wù)所用的密鑰IDSignatureString是簽名結(jié)果串，關(guān)于簽名的計算方法，請參見授權(quán)機制。SignatureMethodString是簽名方式，目前支持HMAC-SHA1TimestampString是請求的時間戳。日期格式按照ISO8601標(biāo)準(zhǔn)表示，必須使用UTC時間。格式為YYYY-MM-DDThh:mm:ssZ例如，2014-05-26T12:00:00Z（為北京時間2014年5月26日20點0分0秒）SignatureVersionString是簽名算法版本，目前版本是1.0Signat

5、ureNonceString是唯一隨機數(shù)，用于防止網(wǎng)絡(luò)重放攻擊。用戶在不同請求間要使用不同的隨機數(shù)值，建議使用13位毫秒時間戳+4位隨機數(shù)50數(shù)據(jù)傳輸/最佳實踐http://$host/index/doc/$app_name?Version=v2&AccessKeyId=$accessKeyId&Signature=$signature&SignatureMethod=HMAC-SHA1&Timestamp=$timestamp&SignatureVersion=1.0&SignatureNonce=$signatureNonce示例公共返回結(jié)果用戶發(fā)送的

6、每次接口調(diào)用請求，無論成功與否，系統(tǒng)都會返回一個status字段給用戶，用來表示本次請求的正確與否。同時，錯誤的請求將會返回錯誤代碼及錯誤描述，供用戶調(diào)試。請求結(jié)束后請務(wù)必檢查返回值是否正常，并根據(jù)錯誤信息及時修改，否則可能出現(xiàn)數(shù)據(jù)丟失或者請求無結(jié)果的情況。示例JSON示例{"status":"OK"}返回成功：返回錯誤：{"status":"FAIL","errors":[{"code":2001,"message":"Appisnotfound"}]}授權(quán)機制OpenSearch服務(wù)會對每個訪問的請求進行身份驗證，通過使用AccessKeyID和Acc

7、essKeySecret進行對稱加密的方法來驗證請求的發(fā)送者身份。AccessKeyID和AccessKeySecret由阿里云官方頒發(fā)給訪問者（可以通過阿里云官方網(wǎng)站申請和管理），其中AccessKeyID用于標(biāo)識訪問者的身份；AccessKeySecret是用于加密簽名字符串和服務(wù)器端驗證簽名字符串的密鑰，必須嚴(yán)格保密，只有阿里云和用戶知道。簽名步驟50數(shù)據(jù)傳輸/最佳實踐1.使用請求參數(shù)構(gòu)造規(guī)范化的請求字符串（CanonicalizedQueryString）注：當(dāng)使用GET方法提交請求時，這些參數(shù)就是請求URI中的參數(shù)部分（即URI中"?"之后由"&

8、"連接的部分）；a.按照參數(shù)名稱的字典順序?qū)φ埱笾兴械恼埱髤?shù)（