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

1、開放搜索API參考手冊開放搜索/API參考手冊開放搜索/API參考手冊 PAGE 50 PAGE 50API參考手冊API概覽系統(tǒng)為開發(fā)者提了一套REST風(fēng)格的WebAPI服務(wù)。本手冊將詳細(xì)介紹WebAPI的功能、使用方法及詳細(xì)參數(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)機(jī)制詳細(xì)說明驗簽過程應(yīng)用操作接口API描述應(yīng)

2、用管理創(chuàng)建、修改、刪除、查看應(yīng)用數(shù)據(jù)處理上傳、修改、刪除文檔搜索查詢表格存儲/API參考手冊表格存儲/API參考手冊錯誤信息查看錯誤日志索引重建創(chuàng)建、查看索引重建任務(wù)配額管理修改、查看配額信息更新歷史- API版本：V2發(fā)布時間更新說明當(dāng)前狀態(tài)發(fā)布時間更新說明當(dāng)前狀態(tài)2014-01-01發(fā)布V2版本，優(yōu)化使用接口，提高查詢性能stable2013-01-01發(fā)布V1版本，提供主流系統(tǒng)操作api接口不維護(hù)狀態(tài)，盡快升級V2調(diào)用方式請求結(jié)構(gòu)服務(wù)地址API入 口部分獲取，切勿隨便使用。通信協(xié)議支持HTTP協(xié)議請求方法推送數(shù)據(jù)建議采用POST方式，搜索建議采用GET方式。 注意：使用POST方式向AP

3、I提交數(shù)據(jù)時需要將HTTP請求的Content-Type設(shè)置為application/x-www-form-urlencoded，否則會導(dǎo)致API解析失敗。數(shù)據(jù)傳輸/最佳實踐數(shù)據(jù)傳輸/最佳實踐請求參數(shù)每個操作都需要包含公共請求參數(shù)及具體請求所特有的請求參數(shù)。字符編碼請求及返回結(jié)果都僅支持UTF-8字符集。公共調(diào)用方式公共請求參數(shù)公共請求參數(shù)是指每個接口都需要使用到的請求參數(shù)。名稱類型是否必須描述VersionString是API 版本，當(dāng)前版本為：v2AccessKeyIdString是阿里云頒發(fā)給用戶的訪問服務(wù)所用的密鑰IDSignatureString是簽名結(jié)果串，關(guān)于簽名的計算方法，請參

4、見授權(quán)機(jī)制。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.0SignatureNonceString是唯一隨機(jī)數(shù)，用于防止網(wǎng)絡(luò)重放攻擊。用戶在不同請求間要使用不同的隨機(jī)數(shù)值，建議使用13位毫秒時間戳+4位隨機(jī)數(shù)http:/$ho

5、st/index/doc/$app_name?Version=v2&AccessKeyId=$accessKeyId&Signature=$signature&SignatureMet hod=HMAC-SHA1&Timestamp=$timestamp&SignatureVersion=1.0&SignatureNonce=$signatureNoncehttp:/$host/index/doc/$app_name?Version=v2&AccessKeyId=$accessKeyId&Signature=$signature&SignatureMet hod=HMAC-SHA1&Times

6、tamp=$timestamp&SignatureVersion=1.0&SignatureNonce=$signatureNonce公共返回結(jié)果用戶發(fā)送的每次接口調(diào)用請求，無論成功與否，系統(tǒng)都會返回一個status字段給用戶，用來表示本次請求的正 確與否。同時，錯誤的請求將會返回錯誤代碼及錯誤描述，供用戶調(diào)試。請求結(jié)束后請務(wù)必檢查返回值是否正常，并根據(jù)錯誤信息及時修改，否則可能出現(xiàn)數(shù)據(jù)丟失或者請求無結(jié)果的 情況。示例JSON示例status: OKstatus: OK返回錯誤：status:FAIL, errors:code:2001, message:App is not found授權(quán)機(jī)

7、制OpenSearch服務(wù)會對每個訪問的請求進(jìn)行身份驗證，通過使用Access Key ID和Access Key Secret進(jìn)行對稱加密的方法來驗證請求的發(fā)送者身份。Access Key ID和Access Key Secret由阿里云官方頒發(fā)給訪問者（可以通過阿里云官方網(wǎng)站申請和管理），其中Access Key ID用于標(biāo)識訪問者的身份；Access Key Secret是用于加密簽名字符串和服務(wù)器端驗證簽名字符串的密鑰，必須嚴(yán)格保密，只有阿里云和用戶知道。簽名步驟使用請求參數(shù)構(gòu)造規(guī)范化的請求字符串（CanonicalizedQuery String）注：當(dāng)使用GET方法提交請求時，這些

8、參數(shù)就是請求URI中的參數(shù)部分（即URI中?之后由&連接的部分）；按照參數(shù)名稱的字典順序?qū)φ埱笾兴械恼埱髤?shù)（包括文檔中描述的公共請求參數(shù)和給定了的請求接口 的自定義參數(shù)，但不能包括公共請求參數(shù)中提到Signature參數(shù)本身）進(jìn)行排序；注：當(dāng)使用GET方法提交請求時，這些參數(shù)就是請求URI中的參數(shù)部分（即URI中?之后由&連接的部分）；對每個請求參數(shù)的名稱和值分別進(jìn)行URL編碼（僅支持UTF-8字符集）。URL編碼的編碼規(guī)則是：A-Z、a-z、0-9以及字符-、_、.、不編碼；對于其他字符編碼成%XY的格式，其中XY是字符對應(yīng)ASCII碼的16進(jìn)制表示。比如英文的雙引號（）對應(yīng)的編碼就是%

9、22；對于擴(kuò)展的UTF-8字符，編碼成%XY%ZA的格式；需要說明的是英文空格（）要被編碼是%20，而不是加號（+）。注意：一般支持URL編碼的庫（比如Java中的.URLEncoder）都是按照application/x-www- form-urlencoded的MIME類型的規(guī)則進(jìn)行編碼的。實現(xiàn)時可以直接使用這類方式進(jìn)行編碼，把編碼后的字符串中加號（+）替換成%20、星號（*）替換成%2A、%7E替換回波浪號（），即可得到上 述規(guī)則描述的編碼字符串。將編碼后的參數(shù)名稱和值使用英文等號（=）連接，得到若干參數(shù)對；將參數(shù)對按照原參數(shù)名稱字典序排序結(jié)果使用&符號依次連接，即得到規(guī)范化請求字符串。

10、使用上一步構(gòu)造的規(guī)范化字符串按照下面的規(guī)則構(gòu)造用于計算簽名的字符串StringToSign= HTTPMethod + & +percentEncode(/) + & + StringToSign= HTTPMethod + & +percentEncode(/) + & + percentEncode(CanonicalizedQueryString)其中HTTPMethod是提交請求用的HTTP方法，比如GET。percentEncode(/)是按照1.b中描述的URL編碼規(guī)則對字符/進(jìn)行編碼得到的值，即%2F。是對第1步中構(gòu)造的規(guī)范化請求字符串按1.b中描述的URL編碼規(guī)則編碼后得到的字

11、符串。按照RFC2104的定義，使用上面的用于簽名的字符串計算簽名HMAC值注意：計算簽名時使用的Key就是用戶持有的Access Key Secret并加上一個&字符(ASCII:38)，使用的哈希算法是SHA1。注意：計算簽名時使用的Key就是用戶持有的Access Key Secret并加上一個&字符(ASCII:38)，使用的哈希算法是SHA1。按照Base64編碼規(guī)則把上面的HMAC值編碼成字符串，即得到簽名值（Signature）。注意: 得到的簽名值在作為最后的請求參數(shù)值提交給OPENSEARCH服務(wù)器的時候，要和其他參數(shù)一樣，按照RFC3986的規(guī)則進(jìn)行URL編碼)最后將得到的

12、簽名值作為Signature參數(shù)添加到請求參數(shù)中，即完成對請求簽名的過程。注意: 得到的簽名值在作為最后的請求參數(shù)值提交給OPENSEARCH服務(wù)器的時候，要和其他參數(shù)一樣，按照RFC3986的規(guī)則進(jìn)行URL編碼)示例公共參數(shù)：Version=v2&AccessKeyId=testid&SignatureMethod=HMACSHA1&SignatureVersion=1.0&SignatureNonce=14 公共參數(shù)：Version=v2&AccessKeyId=testid&SignatureMethod=HMACSHA1&SignatureVersion=1.0&SignatureNo

13、nce=14 053016951271226&Timestamp=2014-07-14T01:34:55Z請求參數(shù)為：query=config=format:json,start:0,hit:20&query=default:的&index_name=ut_3885312&format=json&fetch_fields=title;gmt_modified經(jīng)過第一步排序、編碼及拼接等工作，得到Canonicalized Query String為：AccessKeyId=testid&SignatureMethod=HMAC- SHA1&SignatureNonce=140530169512

14、71226&SignatureVersion=1.0&Timestamp=2014-07- AccessKeyId=testid&SignatureMethod=HMAC- SHA1&SignatureNonce=14053016951271226&SignatureVersion=1.0&Timestamp=2014-07- 14T01%3A34%3A55Z&Version=v2&fetch_fields=title%3Bgmt_modified&format=json&index_name=ut_3885312&q uery=config%3Dformat%3Ajson%2Cstart%3

15、A0%2Chit%3A20%26%26query%3Ddefault%3A%27%E7%9A%84%27GET&%2F&AccessKeyId%3Dtestid%26SignatureMethod%3DHMAC- SHA1%26SignatureNonce%3D14053016951271226%26SignatureVersion%3D1.0%26Timestamp%3D2014-07- 14T01%253A34%253A55Z%26Version%3Dv2%26fetch_fields%3Dtitle%253Bgmt_modified%26format%3Djson%26i ndex_na

16、me%3Dut_3885312%26query%3Dconfig%253Dformat%253Ajson%252Cstart%253A0%252Chit%253A20%2 GET&%2F&AccessKeyId%3Dtestid%26SignatureMethod%3DHMAC- SHA1%26SignatureNonce%3D14053016951271226%26SignatureVersion%3D1.0%26Timestamp%3D2014-07- 14T01%253A34%253A55Z%26Version%3Dv2%26fetch_fields%3Dtitle%253Bgmt_mo

17、dified%26format%3Djson%26i ndex_name%3Dut_3885312%26query%3Dconfig%253Dformat%253Ajson%252Cstart%253A0%252Chit%253A20%2 526%2526query%253Ddefault%253A%2527%25E7%259A%2584%2527假如使用的Access Key Id是testid，Access Key Secret是testsecret，用于計算HMAC的Key就是testsecret&，則計算得到的簽名值Signature是：/GWWQkztlp/9Qg7rry2DuCSf

18、KUQ=/GWWQkztlp/9Qg7rry2DuCSfKUQ=http:/$host/search?query=config%3Dformat%3Ajson%2Cstart%3A0%2Chit%3A20%26%26query%3Ddefault%3A% 27%E7%9A%84%27&index_name=ut_3885312&format=json&fetch_fields=title%3Bgmt_modified&Version=v2&Ac簽名后的請求URL為（注意增加了Signature參數(shù)）：http:/$host/search?query=config%3Dformat%3Ajson

19、%2Cstart%3A0%2Chit%3A20%26%26query%3Ddefault%3A% 27%E7%9A%84%27&index_name=ut_3885312&format=json&fetch_fields=title%3Bgmt_modified&Version=v2&AccessKeyId=testid&SignatureMethod=HMAC- cessKeyId=testid&SignatureMethod=HMAC- SHA1&SignatureVersion=1.0&SignatureNonce=14053016951271226&Timestamp=2014-07-

20、 14T01%3A34%3A55Z&Signature=/GWWQkztlp/9Qg7rry2DuCSfKUQ%3D錯誤碼請求出現(xiàn)錯誤后，將會有錯誤碼及錯誤信息返回，您可以在這里進(jìn)一步確定錯誤原因，及時修改，確保訪問正 確進(jìn)行。常見錯誤處理錯誤碼處理方式1000一般為語法或者超時引起，如果多次刷新不再出現(xiàn)，則是超時引起，如果仍出現(xiàn)，則語法有問題，請對照文檔仔細(xì)檢查，如分隔符、函數(shù)字段類型等2112排序表達(dá)式中的text_relevance(field)、fieldterm_proximity(field)等文本feature中的field必須在查詢的索引包含的源字段中，否則會報錯，但不影響搜索

21、結(jié)果。3007對于API推送系統(tǒng)是有頻率限制，請控制好頻率重試4003可以先按照文檔樣例，試下簽名結(jié)果是否一致，判斷是否是簽名算法問題。如果不是，請檢查下參數(shù)按照字典序排序后應(yīng)該是公共參數(shù)（大寫字母）在前，請求參數(shù)（小寫字母）在后。另外還有空格等一些編碼規(guī)則，具體參考授權(quán)文檔介紹4007一般Json字段內(nèi)容中包含雙引號或者不可見字符會導(dǎo)致格式解析失敗，請轉(zhuǎn)義或者過濾后重試4010TimeStamp參數(shù)是有過期時間的，請按照要求格式取當(dāng)前時間來計算5001沒有找到對應(yīng)的用戶，一般為ACCESSKEY信息不正確，或者使用區(qū)域域名錯誤（API域名請以應(yīng)用管理-基本信息-API入口為準(zhǔn)），請檢查修改后

22、重試5008服務(wù)內(nèi)部是通過Accesskey來進(jìn)行用戶身份校驗的，請確保AccessKey已經(jīng)開啟，您可以通過控制臺AccessKey管理入口來創(chuàng)建和刪除6013start+hit不能超過5000，否則會報錯無結(jié)果。需要超過5000的請求，請查看下API文檔中的SCROLL接口，看是否滿足需求6015請及時到控制臺配額管理處進(jìn)行QPS峰值的調(diào)整，否則超過的請求會被丟棄6127除了query子句，其他子句出現(xiàn)的字段都必須勾選可過濾才能使用。請修改應(yīng)用結(jié)構(gòu)后重試系統(tǒng)級別（1000-1999）錯誤碼錯誤說明1000系統(tǒng)內(nèi)部錯誤1001沒有找到模版1003不支持的索引類型1004服務(wù)暫時不可用，請稍后

23、再試應(yīng)用相關(guān)（2000-2999）錯誤碼錯誤說明2001待查應(yīng)用不存在2002應(yīng)用已經(jīng)存在2003到達(dá)創(chuàng)建應(yīng)用總限制2004應(yīng)用名不可用。應(yīng)用名由數(shù)字、26個英文字母或下劃線組成，長度不超過30位2005應(yīng)用名稱沒有設(shè)定2006新應(yīng)用名稱沒有設(shè)定2007備注不超300字2008摘要配置參數(shù)錯誤2009更新狀態(tài)失敗2010應(yīng)用暫停中2011應(yīng)用凍結(jié)中2012應(yīng)用未開啟2013刪除失敗，沒有此應(yīng)用2014文件上傳失敗2016區(qū)域信息沒有2017此應(yīng)用并不屬于當(dāng)前區(qū)域2099當(dāng)前接口暫時不提供服務(wù)。2101表達(dá)式不存在2102表達(dá)式名稱被占用2103到達(dá)該應(yīng)用表達(dá)式總數(shù)限制2104表達(dá)式名不可用。表

24、達(dá)式名由數(shù)字、26個英文字母或下劃線組成，長度不超過30位2105表達(dá)式名稱沒有設(shè)定2106新表達(dá)式名稱沒有設(shè)定2107表達(dá)式備注不超過300字2108表達(dá)式備注格式錯誤2109表達(dá)式格式錯誤2110表達(dá)式長度超過限制2111表達(dá)式id未指定2112表達(dá)式錯誤2113表達(dá)式不能為空2114操作錯誤2201粗排配置名沒有設(shè)定2202粗排配置名已經(jīng)存在2203粗排配置個數(shù)超出限制2204粗排配置名錯誤。只能由數(shù)字、26個英文字母或下劃線組成2205粗排配置名長度超出限制2206粗排字段必須是數(shù)值型2207粗排配置不存在2208粗排配置錯誤，必須包含字段2209粗排配置權(quán)重錯誤,必須是-100000

25、到100000之間的非0數(shù)值，浮點數(shù)精度支持6位2210與系統(tǒng)默認(rèn)粗排配置重名2211timeliness()的參數(shù)必須是INT類型2112排序表達(dá)式錯誤2551查詢指定的下拉提示規(guī)則不存在文檔相關(guān)（3000-3999）錯誤碼錯誤說明3001文檔不能為空3002文檔大小超過限制3003已經(jīng)到最大文檔數(shù)HTTPDNS/Open APIHTTPDNS/Open API3004保存文檔失敗3005doc格式錯誤3006文檔操作cmd不合法3007請求過于頻繁3008文檔總長度太長3009沒有文檔id授權(quán)相關(guān)（4000-4999）錯誤碼錯誤說明4001認(rèn)證失敗4002需要設(shè)置簽名4003簽名驗證失敗4

26、004需要設(shè)置SignatureNonce4005SignatureNonce不能重復(fù)使用4006SignatureNonce驗證失敗4007解析JSON格式失敗4008用戶名稱不能為空，請檢查域名正確性4009需要指定用戶標(biāo)識4010時間過期4011demo帳號禁止執(zhí)行的操作4012數(shù)據(jù)表不存在4013Timestamp格式錯誤4014需要設(shè)置Timestamp用戶相關(guān)（5000-5999）錯誤碼錯誤說明5001用戶不存在5002用戶名不正確5003需要用戶登錄5005用戶未開通OpenSearch服務(wù)，請前往阿里云官網(wǎng)開通5008用戶沒有啟用ACCESSKEY5100用戶沒有此區(qū)域的操作權(quán)

27、限搜索相關(guān)（6000-6999）錯誤碼錯誤說明6001查詢query為空6002并不被支持的搜索key關(guān)鍵字6003并不被支持的搜索field關(guān)鍵字6004復(fù)雜查詢?yōu)榭?005field無效6006請求包含太多應(yīng)用名6007超出多索引查詢每個模板中索引總數(shù)6008請求串語法錯誤，解析失敗6009查詢子句過長6010無效的rerank size6011SignatureNonce格式錯誤6013start+hit超過系統(tǒng)限制6014因系統(tǒng)繁忙，請求被丟棄6015因流量超出配額，請求被丟棄6016查詢hit數(shù)超過系統(tǒng)限制6017目前scroll只支持search_type為scan，也就是說設(shè)置了

28、參數(shù)scroll，就必須設(shè)置參數(shù)search_type=scan6018設(shè)置了scroll參數(shù)，但沒有search_type參數(shù)6019傳入的scroll_id參數(shù)解析失敗6020無效的scroll參數(shù)值6021scroll請求不支持Aggregate/Sort/Distinct，當(dāng)傳入這些clause時，會報錯6022scroll_id已經(jīng)過期失效了6100查詢詞為空6101查詢的索引字段不存在6102Query中的數(shù)值范圍錯誤6103Filter中的表達(dá)式返回值必須為bool類型6104Sort中的表達(dá)式返回值不能為bool類型6105Sort中存在相同的表達(dá)式CLI/OSS支持CLI/O

29、SS支持6106查詢query語句非法6107統(tǒng)計函數(shù)表達(dá)式的返回值不能為bool或者string類型6108統(tǒng)計中的范圍必須為升序6109統(tǒng)計中的范圍表達(dá)式返回值類型錯誤6110統(tǒng)計函數(shù)不存在6111不支持的統(tǒng)計函數(shù)6112Query 子句錯誤6113Filter子句錯誤6114Aggregate子句錯誤6115Sort子句錯誤6116Distinct子句錯誤6117查詢中包含未知的子句6118語法錯誤6119dist_count值錯誤，應(yīng)該為大于 0的整數(shù)6120dist_times值錯誤，應(yīng)該為大于 0的整數(shù)6121Distinct子句中的reserved值錯誤，應(yīng)為true/false

30、6122Distinct子句缺少distinct_key6123Distinct子句中的grade值錯誤，例如為空，或非數(shù)值6124Distinct子句中包含distinct個數(shù)不對,個數(shù)應(yīng)在(0,26125Distinct子句中的max_item_count值錯誤，應(yīng)該為大于0的整數(shù)6126Distinct子句中的update_total_hit值錯誤，應(yīng)為true/false6127請求中包含了未定義的attribute字段6128表達(dá)式中的二元操作符的兩邊的表達(dá)式結(jié)果類型不匹配6129表達(dá)式中的二元操作符的兩邊表達(dá)式不能同時為常量6130二元邏輯運(yùn)算表達(dá)式類型錯誤，應(yīng)為bool類型613

31、1二元表達(dá)式中不支持string類型6132二元表達(dá)式中不支持?jǐn)?shù)組類型6133位操作中的類型錯誤6134常量表達(dá)式的返回值類型錯誤6300常量表達(dá)式類型應(yīng)是整數(shù)或浮點數(shù)6301位取反操作數(shù)類型必須為整數(shù)6302取負(fù)數(shù)操作數(shù)必須為數(shù)值6303邏輯非操作數(shù)必須為數(shù)值6304二元運(yùn)算操作數(shù)類型錯誤6305非法的二元運(yùn)算符6306函數(shù)參數(shù)類型錯誤6307函數(shù)未定義6308函數(shù)參數(shù)個數(shù)錯誤6309非法的數(shù)組操作6310可過濾字段不存在6311數(shù)組字段被錯當(dāng)作單值使用6312單值字段被錯當(dāng)作數(shù)組使用6313數(shù)組字段下標(biāo)越界(小于0)6314不支持的字段類型6315索引字段參數(shù)不存在6316Query中沒有

32、指定索引6317Filter子句中只能使用一次公式6318公式語法解析出錯6500搜索語法中包含不存在的字段6501在線系統(tǒng)沒有索引數(shù)據(jù)6502用戶query語法錯誤6601一個索引字段只能包含在一個規(guī)則中6602沒有查詢詞，如default:的情況6603查詢中的索引字段沒有在查詢分析規(guī)則中指定6604關(guān)鍵詞沒有使用引號括起來，如default:xxx，正確為default:xxx6605雙引號查詢不能配置查詢分析規(guī)則6607disable參數(shù)格式錯誤6608disable指定關(guān)閉的索引字段不存在6609disable指定關(guān)閉的功能列表不存在E-MapReduce/OpenAPIE-MapR

33、educe/OpenAPI6610查詢分析后的query為空（原query為空，或者全部是stopword）6611查詢中沒有指定索引字段數(shù)據(jù)處理相關(guān)（7000-7999）錯誤碼錯誤說明7100沒有錯誤發(fā)生7101單個文檔過長7102文檔所屬應(yīng)用的元信息錯誤（clientid、應(yīng)用名或表名等不正確）7103HA3 文檔格式錯誤: 字段解析失敗7104JSON文檔格式錯誤：字段解析失敗7105JSON 文檔格式錯誤: json非法7106JSON 文檔格式錯誤: json非法7107不支持的編碼7108編碼轉(zhuǎn)換失敗7109fields中沒有id字段7110fields中id定義不合法7111fi

34、elds中包含保留字段7201HA3 文檔格式錯誤: cmd 非法(cmd 非ADD/UPDATE/DELETE)7202JSON 文檔格式錯誤: cmd 非法(cmd 非ADD/UPDATE/DELETE)7301主鍵字段不存在7302字段數(shù)據(jù)類型錯誤7303數(shù)組字段相關(guān)錯誤7401文檔總數(shù)超出配額7402每日更新文檔數(shù)超出配額7403單次導(dǎo)入的數(shù)據(jù)大小超出配額7500系統(tǒng)內(nèi)部錯誤7501云梯Hive待同步字段的列號超出了當(dāng)前數(shù)據(jù)的列數(shù)范圍7502從Mysql中讀取到的主鍵字段為空,請聯(lián)系數(shù)據(jù)庫管理員7503JsonKeyValueExtractor內(nèi)容轉(zhuǎn)換錯誤: Json格式ECS/用戶指

35、南ECS/用戶指南非法7504JsonKeyValueExtractor內(nèi)容轉(zhuǎn)換錯誤: key不存在7505TairLDBExtractor內(nèi)容轉(zhuǎn)換錯誤: namespace非法（應(yīng)為int32類型）7506TairLDBExtractor內(nèi)容轉(zhuǎn)換錯誤: 從Tair中讀取數(shù)據(jù)失敗7507MySql實時同步過濾條件格式錯誤7508系統(tǒng)內(nèi)部錯誤: 內(nèi)容轉(zhuǎn)換插件初始化失敗7509TairLDBExtractor內(nèi)容轉(zhuǎn)換配置錯誤：Tair連接失敗，請檢查configId 或 namespace 是否有效7510KVExtractor內(nèi)容解析錯誤：KV格式無法解析7511OSS 數(shù)據(jù)讀取失敗7512OS

36、S 內(nèi)容長度超過限度7513OSS 內(nèi)容解析錯誤7514系統(tǒng)內(nèi)部錯誤: OSS LOG 格式不兼容7515過濾條件執(zhí)行錯誤7516字段映射過程中源表字段缺失7517StringCatenateExtractor內(nèi)容轉(zhuǎn)換錯誤: 源字段不存在7518StringCatenateExtractor內(nèi)容轉(zhuǎn)換錯誤: 不支持多值字段7601任務(wù)執(zhí)行錯誤文檔錯誤內(nèi)部通知（8000-8999）錯誤碼錯誤說明8001保存錯誤信息失敗8002必要參數(shù)缺失8003應(yīng)用不存在8004參數(shù)錯誤模板相關(guān)（9000-9999）錯誤碼錯誤說明9001用戶名為空9002應(yīng)用名為空9003模板名不可用。模板名只能由數(shù)字、26個英

37、文字母或下劃線組成9004模板名長度不可超過30位9005查詢模板信息出錯9006模板名字已存在9007插入模板信息出錯9008無效的數(shù)據(jù)9009定義的字段數(shù)目超過系統(tǒng)允許的最大字段數(shù)9010此字段保留字段名9011字段已存在9012索引名稱必須以字母開頭，由數(shù)字、26個英文字母或下劃線組成，長度不超過30位，多值字段類型不能為SWS_TEXT或TEXT9013不支持?jǐn)?shù)組9014不支持主鍵9015未設(shè)定主鍵9016主鍵不唯一9017更新信息失敗9018刪除信息失敗9019包含多個索引字段的搜索字段最多4個9020同一個STRING/TEXT類型的索引字段不能進(jìn)入多個只包含一個字段的搜索字段中9

38、021索引名稱必須以字母開頭，由數(shù)字、26個英文字母或下劃線組成，長度不超過30個9022該表已經(jīng)關(guān)聯(lián)9023索引名不能包含多類型的字段9100系統(tǒng)內(nèi)部錯誤9101該字段超過數(shù)量限制9102該數(shù)據(jù)源未被用到9103無效的外表連接9104最多2級關(guān)聯(lián)9105待查模板不存在9501用戶名為空9502應(yīng)用名為空9519未指定模板9600系統(tǒng)內(nèi)部錯誤9902插件字段類型錯誤9999此域名不提供本服務(wù)數(shù)據(jù)同步相關(guān)（10000-）錯誤碼錯誤說明10001沒有指定的tddl group key，tddl信息獲取失敗10002獲取字段失敗或者表不存在10011連接agg失敗10012應(yīng)用里存在doc10013

39、應(yīng)用不是自定義結(jié)構(gòu)10110該任務(wù)已結(jié)束10010部分?jǐn)?shù)據(jù)源有問題，已經(jīng)忽略有錯誤的數(shù)據(jù)10014數(shù)據(jù)源類型錯誤10100創(chuàng)建任務(wù)失敗，未結(jié)束的任務(wù)已經(jīng)存在10101沒有指定應(yīng)用ID10106沒有指定應(yīng)用ID10107沒有指定應(yīng)用ID10102ACTION無效10112文檔數(shù)量超過限制10201獲取配額列表失敗10202更新配額失敗10301參數(shù)錯誤：參數(shù)未提供或者格式不正確10302時間參數(shù)錯誤10303數(shù)據(jù)源未配置10304該表配額超限10305OSS參數(shù)錯誤10306OSS BUCKET名稱無效10307OSS 記錄類型無效10308OSS BUCKET日志功能未開啟10309存在未完成

40、的任務(wù)10310不是運(yùn)行中的應(yīng)用，無法創(chuàng)建任務(wù)10311時間范圍不合法10312應(yīng)用描述長度超過限制，最多600字10313OSS 內(nèi)容格式不合法10314OSS BUCKET所在區(qū)域ACL網(wǎng)絡(luò)不通10315OSS BUCKET的地址信息不合法10330數(shù)據(jù)源參數(shù)不合法10350連接ODPS服務(wù)失敗10351ODPS 返回錯誤10400OSS前綴不合法10450字段不存在應(yīng)用操作接口應(yīng)用管理類創(chuàng)建應(yīng)用創(chuàng)建一個新應(yīng)用URL/index/$app_name （app_name為要創(chuàng)建的應(yīng)用名稱）支持格式JSONHTTP請求方式GET、POST參數(shù)類型必需參數(shù)類型必需取值范圍默認(rèn)值描述actions

41、tring是createcreatetemplatestring是要創(chuàng)建的應(yīng)用模板名，目前僅支持按照模板創(chuàng)建應(yīng)用返回結(jié)果參數(shù)類型描述statusstring創(chuàng)建應(yīng)用結(jié)果，OK為成功，F(xiàn)AIL為失敗，請根據(jù)返回錯誤碼進(jìn)行排查resultstring創(chuàng)建的應(yīng)用名示例http:/$host/index/test_create_index?action=create&template=abc請求：（此處省略了公共參數(shù)及編碼等因素）http:/$host/index/test_create_index?action=create&template=abc成功返回：result:result:index_

42、name:test_create_index,status:OK, RequestId:1422264399046999200623000status:FAIL,errors:code:2002,message:App already exists, status:FAIL,errors:code:2002,message:App already exists, RequestId:1422264399046999200623888刪除應(yīng)用刪除一個應(yīng)用URL/index/$app_name （app_name為要刪除的應(yīng)用名稱）支持格式JSONHTTP請求方式GET、POST請求參數(shù)參數(shù)類型必

43、需取值范圍默認(rèn)值描述actionstring是deletedelete返回結(jié)果參數(shù)類型描述statusstring訪問結(jié)果，OK為成功，F(xiàn)AIL為失敗，請根據(jù)返回錯誤碼進(jìn)行排查示例http:/$host/index/test_create_index?action=delete請求：（此處省略了公共參數(shù)及編碼等因素）http:/$host/index/test_create_index?action=delete成功返回：result:1,result:1,status:OK, RequestId:1422264710083856300815232status:FAIL,errors:code

44、:2001,message:App is not found, RequestId:142226472107037670080006status:FAIL,errors:code:2001,message:App is not found, RequestId:142226472107037670080006查看應(yīng)用信息查看一個應(yīng)用信息URL/index/$app_name （app_name為要創(chuàng)建的應(yīng)用名稱）支持格式JSONHTTP請求方式GET、POST請求參數(shù)參數(shù)類型必需取值范圍默認(rèn)值描述actionstring是statusstatus返回結(jié)果參數(shù)類型描述statusstring訪問

45、結(jié)果，OK為成功，F(xiàn)AIL為失敗，請根據(jù)返回錯誤碼進(jìn)行排查resultstring應(yīng)用信息，具體信息如下說明- index_name：應(yīng)用名pv：每日搜索請求數(shù)doc_last_update_time：上次更新時間quota：是否超配額信息fields：應(yīng)用結(jié)構(gòu)信息from_table：表結(jié)構(gòu)信息示例請求：（此處省略了公共參數(shù)及編碼等因素）http:/$host/index/test_create_index?action=statushttp:/$host/index/test_create_index?action=status成功返回：result: result: index_name

46、: test_create_index, pv: 0,doc_last_update_time: 0,total_doc_num: 10000, quota: instance: out_of_limit: false,qps: out_of_limit: false,fields: from_table: tables: main: id: name: id,type: TEXT,is_multi: 1,is_pk: 0,src: main.city_id,status: OK,RequestId: 1422267002004077600495891錯誤返回：result:null,resu

47、lt:null,status:FAIL,errors:code:2001,message:App is not found, RequestId:14222669850171034003366獲取應(yīng)用列表獲得當(dāng)前應(yīng)用URL/index支持格式JSONHTTP請求方式GET、POST請求參數(shù)參數(shù)類型必需取值范圍默認(rèn)值描述pageint否獲取第幾頁應(yīng)用列表page_sizeint否每頁返回的應(yīng)用個數(shù)返回結(jié)果參數(shù)類型描述statusstring訪問結(jié)果，OK為成功，F(xiàn)AIL為失敗，請根據(jù)返回錯誤碼進(jìn)行排查createdint應(yīng)用創(chuàng)建時間戳namestring應(yīng)用名稱idint應(yīng)用idtotalint

48、總的應(yīng)用個數(shù)示例http:/$host/index?page=1&page_size=1請求：（此處省略了公共參數(shù)及編碼等因素）http:/$host/index?page=1&page_size=1成功返回：result: id: 107557,name: test_create_index, description: test, created: 1422266999多媒體云/使用技巧和技術(shù)探討多媒體云/使用技巧和技術(shù)探討,total: 2,status: OK,RequestId: 1422268539021275800907873數(shù)據(jù)處理類上傳文檔支持新增、更新、刪除的批量操作URL/

49、index/doc/$app_name （app_name為要操作的應(yīng)用名稱）支持格式JSONHTTP請求方式POST請求參數(shù)參數(shù)類型必需取值范圍默認(rèn)值描述actionstring是pushtable_namestring是要上傳數(shù)據(jù)的表名itemsstring是規(guī)定JSON格式，如下所示cmd: add,timestamp: 1401342874777,fields: id: 1,fields: id: 1,title: This is the title, body: This is the body,cmd: update, timestamp: 1401342874778, field

50、s:id: 2,title: This is the new title,cmd: delete, fields: id: 3cmd : 必選字段。定義該文檔的操作行為，可以為add、update、delete。建議一個請求中進(jìn)行批量更新操作，提高網(wǎng)絡(luò)交互及處理效率。add表示新增文檔，如果該主鍵對應(yīng)文檔已經(jīng)存在，則執(zhí)行先delete再add的操作；update表示更新文檔，對該主鍵對應(yīng)文檔進(jìn)行部分字段更新，如果未存在主鍵文檔，則執(zhí)行add操作；delete表示刪除文檔，如果該主鍵對應(yīng)文檔已經(jīng)不存在，則認(rèn)為刪除成功。timestamp : 可選字段。用來記錄文檔實際發(fā)生時間，單位為毫秒。系統(tǒng)會

51、用該時間戳來作為同一主鍵文檔更新順序的判斷標(biāo)準(zhǔn)。如果沒有timestamp項，則默認(rèn)以文檔發(fā)送到OpenSearch的時間作為 文檔更新時間來進(jìn)行保序操作。fields : 必選字段。要操作的文檔內(nèi)容，主鍵字段必選，系統(tǒng)所有操作都是通過主鍵來進(jìn)行的。對于delete只需要提供文檔主鍵即可。對于Array類型，需要使用JsonArray來處理，如fields: id: 0,int_array: 14,85,string_array: abc,xyz,cmdADD；注意：最外層是JsonArray類型，支持多個文檔批量操作。返回結(jié)果參數(shù)類型描述statusstring執(zhí)行結(jié)果，OK為成功，F(xiàn)AIL

52、為失敗，請根據(jù)返回錯誤碼進(jìn)行排查request_idstring該條查詢的記錄id，主要用于排查問題使用示例http:/$host/index/doc/test_create_index?action=push&table_name=main/items建議放到body體中http:/$host/index/doc/test_create_index?action=push&table_name=main/items建議放到body體中items=cmd:add,timestamp:1401342874777,fields:id:1,title:Thisisthetitle,body:This

53、isthe body成功返回：status:OK,request_id:1422348642065805100373587status:OK,request_id:1422348642065805100373587status:FAIL,errors:code:4012,message:Table dose not exist,request_id:1422348739084222300234072status:FAIL,errors:code:4012,message:Table dose not exist,request_id:1422348739084222300234072注意事項使

54、用API/SDK推送數(shù)據(jù)有次數(shù)及大小限制，具體值請參考系統(tǒng)限制項。數(shù)據(jù)上傳后請務(wù)必檢查返回值，并對相關(guān)錯誤碼進(jìn)行重試（尤其是3007錯誤），否則會出現(xiàn)數(shù)據(jù)丟失 情況。同時，數(shù)據(jù)處理是異步的，系統(tǒng)返回OK后只表示系統(tǒng)接收數(shù)據(jù)成功，數(shù)據(jù)處理過程的錯誤會 在控制臺錯誤信息中展示，請注意及時檢查。（2M以上），服務(wù)器將拒絕接收任何參數(shù)，同時返 回異常。POST的url及body部分最好都要做url_encode，否則會出現(xiàn)解析及簽名問題。搜索類搜索系統(tǒng)提供了豐富的搜索語法以滿足用戶各種場景下的搜索需求。URL/search支持格式JSONOSS/最佳實踐OSS/最佳實踐HTTP請求方式GET請求參數(shù)參

55、數(shù)類型必需取值范圍默認(rèn)值描述querystring是搜索主體，包含所有的查詢條件。主要子句分別包含config子句、query子句、sort子句、filter子句、aggregate子句 、 distinct子句、kvpairs子句。index_namestring是要查詢的應(yīng)用名。支持同一查詢條件下的多應(yīng)用同時查詢，應(yīng)用名間使用英文分號（;）分隔。fetch_fieldsstring否全部可展示字段?？梢酝ㄟ^此參數(shù)獲取本次查詢需要的字段內(nèi)容，多個字段使用英文分號（;）分隔qpstring否已上線規(guī)則指定要使用的查詢分析規(guī)則，多個規(guī)則使用英文逗號（,）分隔disablestring否關(guān)閉已生效

56、的查詢分析功能first_formul a_namestring否系統(tǒng)中默認(rèn)粗排表達(dá)式名字設(shè)置粗排表達(dá)式名字formula_na mestring否系統(tǒng)中默認(rèn)精排表達(dá)式設(shè)置精排表達(dá)式名字日志服務(wù)/計費說明日志服務(wù)/計費說明名字summarystring否獲取系統(tǒng)結(jié)果摘要配置動態(tài)摘要的配置，可以指定某些字段的飄紅、截斷等操作。query參數(shù)：查詢的主體?？梢酝ㄟ^若干子句的組合來實現(xiàn)多樣的搜索需求，其中query子句為必選，子句與子句之前通過&進(jìn)行連接；disable參數(shù)：目前僅支持qp。index_name參數(shù)：多應(yīng)用聯(lián)合查詢說明請見本節(jié)的多應(yīng)用聯(lián)合查詢介紹；fetch_fields參數(shù)：返回文

57、本數(shù)據(jù)大小對查詢性能影響較大，建議只獲取需要的字段。summary參數(shù)：格式如下表，summary_prefix與summary_postfix必須同時設(shè)定；同時、summary_postfix）是相互影響的，出現(xiàn)在后面的配置會 覆蓋前面。另外，目前不支持摘要和飄紅單獨設(shè)置。參數(shù)類型必需取值范圍默認(rèn)值描述summary_fi eldstring是要做摘要的字段summary_el ementstring否em飄紅標(biāo)簽，html標(biāo)簽去掉左右尖括號summary_ell ipsisstring否.摘要的結(jié)尾省略符summary_sn ippedint否1選取的摘要片段個數(shù)summary_le ns

58、tring否摘要要展示的片段長度summary_el ement_prefi xstring否飄紅的前綴，必須是完整的html標(biāo)簽，如summary_el ement_postf ixstring否飄紅的后綴，必須是完整的html標(biāo)簽，如返回結(jié)果參數(shù)類型描述statusstring執(zhí)行結(jié)果，OK為成功，F(xiàn)AIL為失敗，請根據(jù)返回錯誤碼進(jìn)行排MongoDBMongoDB/相關(guān)協(xié)議查request_idstring該條查詢的記錄id，主要用于排查問題使用resultstring實際返回結(jié)果，包括查詢耗時searchtime、引擎總結(jié)果數(shù)total、本次請求返回結(jié)果數(shù)num、本次查詢最大返回結(jié)果數(shù)v

59、iewtotal、查詢結(jié)果items、統(tǒng)計結(jié)果facet等信息errorsstring錯誤內(nèi)容，error_message代表錯誤信息。error_code代表錯誤碼searchtime指引擎耗時，單位為秒。其中fields為搜索返回字段內(nèi)容，variableValue為自定義 參數(shù)返回結(jié)果，如獲取distance距離值。節(jié)點只有在config子句的format為xml或者fulljson時才能展現(xiàn)出來，json格式默 認(rèn)不展示。total、viewtotal、num區(qū)別：total為一次查詢（不考慮config子句）引擎中符合條件的結(jié)果數(shù)（在 結(jié)果數(shù)較多情況下，該值會做優(yōu)化），但考慮到性能及

60、相關(guān)性，引擎最多會返回viewtotal個結(jié)果，如 果需要翻頁的話，要求start+hit一定要小于viewtotal，total一般用來做展示。num為本次查詢請求（受config子句的start及hit）實際返回的條目，不會超過hit值。示例http:/$host/search?index_name=bbs&query=config=start:0,hit:10,format=fulljson&query=default:的&filter=create_timestamp1423000000&sort=+type;- RANK&fetch_fields=id;title;body;url;