管控API介面調用參考合集-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

API標準及多語言預置SDK

本產品（OpenSearch/2017-12-25）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

應用執行個體

API	標題	API概述
應用管理	應用管理
DescribeAppGroup	查看應用執行個體詳情	查看一個 OpenSearch 應用詳情。
RenewAppGroup	為應用續約（暫不支援）	為應用續約（續約暫不支援API調用，請在控制台操作續約）。
CreateAppGroup	建立一個應用	建立一個OpenSearch應用。
ModifyAppGroup	修改應用屬性或設定應用線上版本	修改 OpenSearch 應用屬性或設定應用線上版本。
ModifyAppGroupQuota	修改應用配額	修改 OpenSearch 應用配額。
UpdateAppGroupDeleteProtection	修改執行個體刪除保護	應用刪除保護
RemoveAppGroup	刪除APP分組	刪除一個OpenSearch應用。
ListAppGroups	擷取應用列表	擷取OpenSearch應用列表。
應用版本	應用版本
CreateApp	建立一個應用版本	建立一個OpenSearch應用版本。
RemoveApp	刪除一個應用版本	刪除一個 OpenSearch應用版本。
DescribeApps	擷取一個應用的版本列表	擷取一個 OpenSearch 應用的版本列表。
DescribeApp	查看一個應用版本詳情	查看一個 OpenSearch 應用版本詳情。
DescribeAppStatistics	擷取應用版本的統計結果	擷取 OpenSearch 應用版本的統計結果。

執行個體周邊

API	標題	API概述
自訂分析器	自訂分析器
ListUserAnalyzers	擷取使用者的自訂分詞器列表	擷取使用者的自訂分詞器列表。
CreateUserAnalyzer	建立自訂分析器	建立自訂分析器。
DescribeUserAnalyzer	擷取自訂分析器詳情	擷取自訂分析器詳情。
RemoveUserAnalyzer	刪除自訂分析器	刪除自訂分析器。
ListUserAnalyzerEntries	擷取自訂分析器詞條清單	擷取自訂分析器詞條清單。
PushUserAnalyzerEntries	接收自訂分析器詞條變更	接收自訂分析器詞條變更。
ABTest	ABTest
實驗場景	實驗場景
ListABTestScenes	列出情境清單	列出情境清單。
CreateABTestScene	CreateABTestScene	Creates an experiment scenario.
DescribeABTestScene	擷取ABTest實驗情境詳情	擷取實驗情境詳情。
UpdateABTestScene	修改實驗情境	修改實驗情境。
DeleteABTestScene	刪除 ABTest 實驗情境	刪除實驗情境。
實驗組	實驗組
ListABTestGroups	擷取實驗組清單	擷取實驗組清單。
CreateABTestGroup	建立 ABTest 實驗組	建立實驗組。
DeleteABTestGroup	刪除 ABTest 實驗組	刪除實驗組。
DescribeABTestGroup	擷取 ABTest 實驗組詳情	擷取實驗組詳情。
UpdateABTestGroup	修改 ABTest 實驗組	修改實驗組。
實驗	實驗
ListABTestExperiments	列出實驗清單	列出實驗清單。
CreateABTestExperiment	建立 ABTest 測試實驗	建立實驗。
DescribeABTestExperiment	擷取 ABTest 實驗詳情	擷取實驗詳情。
UpdateABTestExperiment	修改實驗參數	修改實驗參數。
DeleteABTestExperiment	刪除 ABTest 實驗	刪除實驗。
白名單	白名單
ListABTestFixedFlowDividers	擷取 ABTest 白名單清單	擷取白名單清單。
UpdateABTestFixedFlowDividers	更新 ABTest 白名單資料	更新白名單資料。
粗排運算式	粗排運算式
ListFirstRanks	擷取指定應用版本的粗排配置列表	擷取指定OpenSearch應用版本的粗排配置列表。
CreateFirstRank	建立一個應用版本的粗排運算式配置	建立一個OpenSearch應用版本的粗排運算式配置。當 dryRun=true 時，表示進行粗排運算式校正，預設 dryRun不傳為false。
DescribeFirstRank	查看一個應用版本的粗排運算式配置	查看一個 OpenSearch 應用版本的粗排運算式配置。
RemoveFirstRank	刪除粗排規則	刪除指定 OpenSearch 應用版本的粗排配置。
ModifyFirstRank	修改一個應用版本的粗排運算式配置	修改一個 OpenSearch 應用版本的粗排運算式配置當 dryRun=true 時，表示修改後的粗排運算式進行校正，預設 dryRun 不傳為 false。
精排運算式	精排運算式
ListSecondRanks	擷取某版本的精排排配置列表	擷取指定 OpenSearch 應用版本的精排排配置列表。
CreateSecondRank	建立一個應用版本的精排配置	當 dryRun=true 時，表示進行精排運算式校正，預設 dryRun 不傳為 false。
DescribeSecondRank	查看一個應用版本的精排運算式配置	查看一個 OpenSearch 應用版本的精排運算式配置。
ModifySecondRank	修改一個應用版本的精排配置	修改一個OpenSearch 應用版本的精排配置。當 dryRun=true 時，表示修改後的精排運算式進行校正，預設 dryRun 不傳為 false。
RemoveSecondRank	刪除精排規則	刪除一個 OpenSearch 應用版本的精排運算式配置。
查詢分析器	查詢分析器
ListQueryProcessors	取某版本的查詢分析規則列表	擷取指定OpenSearch應用版本的查詢分析規則列表。
CreateQueryProcessor	建立查詢分析規則	建立一個查詢分析規則。當 dryRun=true 時，表示進行查詢分析規則校正，預設 dryRun 不傳為 false。
ModifyQueryProcessor	修改指定應用版本查詢分析規則	修改指定應用版本查詢分析規則。當 dryRun=true 時，表示進行查詢分析規則校正，預設 dryRun 不傳為 false。
RemoveQueryProcessor	刪除指定應用版本的查詢分析規則	刪除指定 OpenSearch 應用版本的查詢分析規則。
DescribeQueryProcessor	擷取指定應用版本的查詢分析規則列表	擷取指定 OpenSearch 應用版本的查詢分析規則列表。
ListQueryProcessorNers	擷取推薦的實體類型重要性設定	實體識別：擷取推薦的實體類型重要性設定。
ListQueryProcessorAnalyzerResults	查詢分析效果測試	查詢分析效果測試。（僅限開源相容版存量應用調用）
干預詞典	干預詞典
ListInterventionDictionaries	擷取使用者的幹預詞典列表	擷取使用者的幹預詞典列表。
CreateInterventionDictionary	建立幹預詞典	建立幹預詞典。
DescribeInterventionDictionary	擷取幹預詞典詳情	擷取幹預詞典詳情。
RemoveInterventionDictionary	刪除幹預詞典	刪除幹預詞典。
ListInterventionDictionaryEntries	擷取幹預詞條清單	擷取幹預詞條清單。
PushInterventionDictionaryEntries	接收幹預詞條變更	接收幹預詞條變更。
ListInterventionDictionaryRelatedEntities	擷取與幹預詞典關聯的資源清單	擷取與幹預詞典關聯的資源清單。如果某個幹預詞典被qp引用，則列出來所有的應用及QP資訊。
ListInterventionDictionaryNerResults	擷取實體識別結果	擷取實體識別結果。
最佳化大師	最佳化大師
EnableSlowQuery	啟用最佳化大師慢查詢服務	啟用最佳化大師慢查詢服務。
DisableSlowQuery	禁用最佳化大師慢查詢服務	禁用最佳化大師慢查詢服務。
DescribeSlowQueryStatus	擷取最佳化大師慢查詢開通狀態	擷取最佳化大師慢查詢開通狀態。
StartSlowQueryAnalyzer	立即進行慢查詢分析	立即進行慢查詢分析。
ListSlowQueryQueries	列出慢查詢Query清單	列出最佳化大師慢查詢Query清單。
ListSlowQueryCategories	列出最佳化大師慢查詢最佳化建議清單	列出最佳化大師慢查詢最佳化建議清單。
配額審批	配額審批
ListQuotaReviewTasks	擷取指定應用配額審批清單	擷取指定 opensearch 應用配額審批清單。
定時任務	定時任務
ListScheduledTasks	擷取應用定時工作清單	擷取OpenSearch應用定時工作清單。
CreateScheduledTask	建立一個應用的定時任務	建立一個 OpenSearch 應用的定時任務。
DescribeScheduledTask	查看應用定時任務詳情	查看 OpenSearch 應用定時任務詳情。
ModifyScheduledTask	修改一個定時任務	修改一個定時任務。
RemoveScheduledTask	刪除計劃任務	刪除 OpenSearch 應用定時任務。
搜尋策略	搜尋策略
ListSortExpressions	擷取應用版本上的排序運算式列表	擷取應用版本上的排序運算式列表。
ElasticSearch引擎執行個體	ElasticSearch引擎執行個體
UnbindEsInstance	卸載依賴庫執行個體	為 opensearch 應用解除綁定es執行個體。
BindEsInstance	綁定依賴性庫執行個體	綁定依賴性 Elasticsearch 執行個體。
BindESUserAnalyzer	為es執行個體綁定自訂分析器	為es執行個體綁定自訂分析器。
UnbindESUserAnalyzer	為Elasticsearch執行個體解除綁定自訂分析器	為Elasticsearch執行個體解除綁定自訂分析器。
目前處理流	目前處理流
ListProceedings	顯示AppGroup進行中的離線匯入的工作清單	查看當前的處理流。
統計	統計
ListStatisticLogs	查詢日誌類統計	查詢日誌類統計，例如：應用錯誤記錄檔、熱詞榜單、慢日誌。
ListStatisticReport	報告類統計查詢	應用情境有：應用報表、下拉提示報表、熱詞底紋報表、abtest報表、資料品質報告等。
cava指令碼	cava指令碼
ListSortScripts	擷取指定版本下所有的排序指令碼	擷取指定版本下所有的排序指令碼。
UpdateSortScript	修改排序指令碼備忘	修改排序指令碼備忘。
SaveSortScriptFile	儲存排序指令檔	上傳排序指令碼內容。
ReleaseSortScript	發布排序指令碼	發布排序指令碼。
GetSortScriptFile	擷取排序指令碼內容	擷取排序指令碼內容。
GetSortScript	擷取排序指令碼詳情	擷取排序指令碼詳情。
GetScriptFileNames	擷取指令檔名稱列表	擷取指定版本指定指令碼下所有的檔案名稱。
DeleteSortScriptFile	刪除排序指令檔	刪除指令檔。
DeleteSortScript	刪除排序指令碼	刪除排序指令碼。
CreateSortScript	建立排序指令碼	建立排序指令碼。
CompileSortScript	編譯排序指令碼	編譯排序指令碼。
查詢策略	查詢策略
UpdateSearchStrategy	更新搜尋策略	支援dryrun。
RemoveSearchStrategy	刪除查詢策略	刪除查詢策略。
ListSearchStrategies	擷取查詢策略詳情	擷取查詢策略詳情。
GetSearchStrategy	擷取搜尋策略	擷取查詢策略詳情。
CreateSearchStrategy	建立查詢策略	建立查詢策略。

版本周邊

API	標題	API概述
預設展示欄位	預設展示欄位
UpdateFetchFields	更新應用版本的預設展示欄位	支援 dryRun。
搜尋結果摘要	搜尋結果摘要
UpdateSummaries	設定指定應用版本摘要	支援 dryRun。

演算法周邊

API	標題	API概述
CreateFunctionResource	建立演算法資源	建立指定功能下的演算法資源。
GetFunctionCurrentVersion	擷取目前的版本	擷取當前功能建立執行個體時使用的版本資訊。
GetFunctionVersion	擷取版本詳情	根據版本ID擷取版本資訊。
GetFunctionDefaultInstance	擷取預設執行個體	擷取app預設使用的演算法執行個體。
UpdateFunctionDefaultInstance	設定預設執行個體	為指定app設定預設使用的演算法執行個體，自動覆蓋上一次設定的預設執行個體空表示取消預設執行個體。
ListFunctionTasks	擷取訓練記錄	擷取訓練記錄。返回結果按開始時間降序排序。
GetFunctionTask	擷取訓練詳情	擷取訓練詳情。
DeleteFunctionTask	刪除訓練記錄	刪除訓練記錄。正在訓練中的記錄無法刪除。
CreateFunctionTask	啟動演算法訓練	啟動一個訓練任務。
ListFunctionInstances	擷取執行個體列表	擷取使用者下，合格所有執行個體。
GetFunctionInstance	擷取執行個體詳情	根據執行個體名稱擷取執行個體詳情。
DeleteFunctionInstance	刪除演算法執行個體	刪除演算法執行個體，刪除前請確保該執行個體不在使用中，以免影響線上服務。
UpdateFunctionInstance	更新演算法執行個體	根據執行個體名稱更新執行個體資訊。
GetFunctionResource	擷取演算法資源	擷取指定名稱的演算法資源。
ListFunctionResources	ListFunctionResources	Lists the algorithm resources.
DeleteFunctionResource	刪除演算法資源	刪除指定演算法資源。
UpdateFunctionResource	更新演算法資源	更新演算法資源。
CreateFunctionInstance	建立演算法執行個體	建立指定功能的一個演算法執行個體。

其它(未在目錄中的文件)

API	標題	API概述
ValidateDataSources	驗證資料來源	驗證資料來源。
ReplaceAppGroupCommodityCode	應用服務型轉執行個體型	應用服務型轉執行個體型。
ListDataSourceTables	擷取指定執行個體的資料來源列表	擷取指定資料來源的所有資料。
ListDataSourceTableFields	擷取指定資料表的所有欄位	擷取指定資料表的所有欄位，為內部介面。
GetDomain	擷取行業類型	擷取行業類型。
GenerateMergedTable	擷取合并後的寬表	擷取合并後的寬表。
DescribeRegions	查詢可以使用的阿里雲地區	擷取所有地區的接入地址。

其他

API	標題	API概述
DescribeDataCollction	DescribeDataCollection	擷取指定應用的資料擷取詳情。
ListDataCollections	ListDataCollections	擷取OpenSearch應用的資料擷取清單。
RemoveDataCollection	RemoveDataCollection	關閉資料擷取。
UntagResources	刪除標籤	刪標籤介面。
ListTagResources	查標籤列表	查標籤介面。
TagResources	為執行個體打標籤	打標籤介面。
CreateAppGroupCredentials	建立應用組憑據	按需建立指定應用組的訪問憑據，支援dryRun模式預覽操作。