API概覽-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

API標準及多語言預置SDK

本產品（searchengine/2021-10-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概述
ChangeResourceGroup	修改資源群組	修改資源群組。
TagResources	批量增加/更新標籤	批量增加/更新標籤。
UntagResources	大量刪除標籤	大量刪除標籤。
ListTagResources	查詢資源標籤關係列表	查詢資源標籤關係列表。
ModifyPublicUrlIpList	修改公網域名白名單。	修改公網域名白名單。
ListInstances	擷取執行個體列表	擷取執行個體列表。
GetInstance	根據執行個體ID查看執行個體詳情	通過指定的執行個體ID查看執行個體詳情。

配置中心

API	標題	API概述
線上表配置	線上表配置
ModifyIndex	修改索引	修改索引。
StartIndex	恢複使用索引	恢複使用索引。
StopIndex	停止使用索引	停止使用索引。
CreateIndex	建立索引資訊	建立索引資訊。
BuildIndex	觸發索引重建	觸發索引重建。
GetIndex	查看索引表詳情	查看索引表版本詳情。
ListIndexes	擷取索引列表	擷取索引列表。
索引結構	索引結構
CreateConfigDir	進階配置建立檔案目錄	進階配置建立檔案目錄。
CreateConfigFile	進階配置建立檔案	進階配置建立檔案。
DeleteConfigDir	刪除進階配置目錄	刪除進階配置目錄。
DeleteConfigFile	刪除進階設定檔	刪除進階設定檔。
ModifyAdvanceConfig	修改http、git類型的檔案內容	修改http、git類型的檔案內容。
ListAdvanceConfigs	擷取進階配置列表	擷取進階配置列表。
進階配置	進階配置
ListSchemas	根據資料同步配置擷取schema資訊	根據資料同步配置擷取schema資訊。
ModifyDataSourceDeploy	修改資料來源部署資訊	修改資料來源部署資訊。
GetDataSourceDeploy	擷取資料來源部署資訊	擷取資料來源部署資訊。
資料來源配置	資料來源配置

維運中心

API	標題	API概述
sql開發	sql開發
CloneSqlInstance	複製 SQL 執行個體	複製 SQL 執行個體。
CreateFolder	建立目錄	建立目錄。
CreateSqlInstance	建立 SQL 執行個體	建立 SQL 執行個體。
DeleteSqlInstance	刪除SQL執行個體	刪除SQL執行個體。
ExecuteSqlInstance	執行SQL執行個體。	執行SQL執行個體。
GetDatabaseSchema	擷取資料庫schema	擷取資料庫schema。
GetSqlInstance	取得 SQL 執行個體資訊	取得 SQL 執行個體資訊。
ListDatabases	展示已有資料庫	展示已有的資料庫。
UpdateSqlInstanceContent	更新SQL執行個體內容	更新SQL執行個體內容。
UpdateSqlInstanceName	更新SQL執行個體名稱	更新SQL執行個體名稱。
UpdateSqlInstanceParams	更新SQL執行個體參數	更新SQL執行個體參數。
DeleteFolder	刪除目錄	刪除目錄。
RenameFolder	修改目錄名稱	修改目錄名稱。
變更歷史	變更歷史
ListTasks	擷取執行個體的變更歷史	擷取執行個體的變更歷史。
日誌管理	日誌管理
ListLogs	查詢執行個體日誌	查詢執行個體日誌。
部署管理	部署管理
ListIndexRecoverRecords	擷取恢複資料記錄	擷取恢複資料記錄。
ListPausePolicys	擷取暫停策略	擷取暫停策略。
ModifyPausePolicy	修改暫停開關	修改暫停開關。
維運管理	維運管理

表管理

API	標題	API概述
表別名管理	表別名管理
ModifyAlias	修改表別名	修改表別名。
ListAliases	查詢表別名列表	查詢表別名列表。
DeleteAlias	刪除別名	刪除別名。
CreateAlias	建立別名	建立別名。
CreateTable	建立索引表	建立索引表。
ModifyTable	修改索引表	修改索引表。
GetTable	取得索引表資訊	取得索引表資訊。

其他

API	標題	API概述
ListPostQueryResult	召回引擎版使用POST請求擷取搜尋測試結果	召回引擎版使用POST請求擷取搜尋測試結果。
ListRestQueryResult	召回引擎版擷取rest查詢搜尋測試結果	召回引擎版擷取rest查詢搜尋測試結果。
ListVectorQueryResult	向量檢索版擷取向量查詢搜尋測試結果	向量檢索版擷取向量查詢搜尋測試結果。
PushDocuments	推送資料	推送資料。
DeleteModel	刪除模型	刪除模型。
ModifyModel	修改模型	修改模型詳情，修改模型狀態。
DebugModel	模型調試	調試模型。
GetModel	擷取模型詳細資料	通過執行個體ID和模型名稱查詢特定模型的詳細配置資訊。
ListModels	模型列表	透過執行個體 ID 查詢指定條件下的模型列表。
CreateModel	建立模型	建立模型資訊。
ModifySearcherReplica	修改資料節點副本分區數	通過指定執行個體ID來修改資料節點的副本或分區數量。

Others

API	標題	API概述
CreateCluster	新增叢集	新增叢集。
CreateDataSource	建立資料來源	建立資料來源。
CreateInstance	建立執行個體	建立問天引擎執行個體。
CreatePublicUrl	開通公網域名	開通公網域名。
DeleteAdvanceConfig	刪除進階配置的詳情	刪除進階配置的詳情。
DeleteDataSource	刪除資料來源	刪除資料來源。
DeleteIndex	刪除索引	刪除索引。
DeleteIndexVersion	刪除索引的版本	刪除索引的版本。
DeleteInstance	刪除執行個體	刪除指定執行個體。
DeletePublicUrl	刪除公網域名	刪除公網域名。
DeleteTable	刪除索引表	刪除索引表。
DescribeRegions	擷取雲產品地區列表	擷取雲產品地區列表。
ForceSwitch	強制切換	強制切換。
GetAdvanceConfig	擷取詞典資訊	擷取詞典資訊。
GetAdvanceConfigFile	擷取詞典資訊	擷取詞典資訊。
GetCluster	擷取某一叢集的詳細資料	擷取某一叢集的詳細資料。
GetClusterRunTimeInfo	擷取叢集資訊	擷取叢集資訊。
GetDataSource	擷取某一資料來源	擷取某一資料來源。
GetDeployGraph	展示部署全域概覽	展示部署全域概覽。
GetFile	查看索引表版本詳情	查看索引表版本詳情。
GetIndexOnlineStrategy	擷取某一索引線上策略	擷取索引線上生效策略。
GetIndexVersion	擷取叢集可復原的索引資訊	擷取叢集可復原的索引資訊。
GetNodeConfig	取得節點配置資訊	取得節點配置資訊。
GetTableGeneration	根據generationId擷取某個索引版本狀態	根據generationId擷取某個索引版本狀態。
ListAdvanceConfigDir	取得進階配置目錄下檔案列表	取得進階配置目錄下檔案列表。
ListClusterNames	擷取叢集可選擇的名稱	擷取叢集可選擇的名稱。
ListClusterTasks	展示叢集任務	展示叢集任務。
ListClusters	擷取叢集列表	擷取叢集列表。
ListDataSourceSchemas	擷取某一資料來源的schema資訊	擷取某一資料來源的schema資訊。
ListDataSourceTasks	展示資料來源任務	展示資料來源任務。
ListDataSources	擷取資料來源列表	擷取資料來源列表。
ListDateSourceGenerations	擷取資料來源的歷史迴流資訊	擷取資料來源的歷史迴流資訊。
ListInstanceSpecs	擷取叢集可選擇的規格列表	擷取叢集可選擇的規格列表。
ListOnlineConfigs	擷取線上表配置的詳情	擷取線上表配置的詳情。
ListQueryResult	擷取搜尋測試結果	擷取搜尋測試結果。
ListTableGenerations	擷取索引generation列表	擷取索引generation列表。
ListTables	擷取索引列表	擷取索引列表。
ModifyAdvanceConfigFile	修改詞典。	修改詞典。
ModifyClusterDesc	更改叢集的描述資訊	更改叢集的描述資訊。
ModifyClusterOfflineConfig	修改叢集的配置資訊	修改叢集的配置資訊。
ModifyClusterOnlineConfig	修改叢集的線上配置資訊	修改叢集的線上配置資訊。
ModifyFile	修改檔案	修改檔案。
ModifyIndexOnlineStrategy	修改某一索引線上策略	修改索引線上策略。
ModifyIndexPartition	修改索引分割區資訊	快速擴縮列。
ModifyIndexVersion	修改叢集索引版本（索引復原）	修改叢集索引版本（索引復原）。
ModifyNodeConfig	修改節點配置	修改節點配置。
ModifyOnlineConfig	修改線上表配置	修改線上表配置。
ModifyPassword	修改執行個體的密碼	修改執行個體的密碼。
PublishAdvanceConfig	發佈進階版本	發佈進階版本。
PublishIndexVersion	發布索引版本	發布索引版本。
RecoverIndex	從索引中恢複資料	從索引中恢複資料。
Reindex	重建索引	重建索引。
RemoveCluster	刪除某一叢集	刪除某一叢集。
StopTask	停止fsm任務	停止fsm任務。
UpdateInstance	修改指定執行個體配置	修改指定執行個體配置。