开放搜索-问天引擎有哪些API接口_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

本产品（searchengine/2021-10-25）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

实例

API	标题	API概述
ChangeResourceGroup	修改资源组	修改资源组。
TagResources	批量增加/更新标签	批量增加/更新标签。
UntagResources	批量删除标签	批量删除标签。
ListTagResources	查询资源标签关系列表	查询资源标签关系列表。
CreatePublicUrl	开通公网域名	开通公网域名。
DeletePublicUrl	删除公网域名	删除公网域名。
ModifyPublicUrlIpList	修改公网域名白名单	修改公网域名白名单。
CreateInstance	创建实例	创建问天引擎实例。
DeleteInstance	删除实例	删除指定实例。
UpdateInstance	修改指定实例配置	修改指定实例配置。
ModifyPassword	修改实例的密码	修改实例的密码。
ListInstances	获取实例列表	获取实例列表。
GetInstance	根据实例ID查看实例详情	通过指定的实例ID查看实例详情。
ListInstanceSpecs	获取集群可选择的规格列表	获取集群可选择的规格列表。

配置中心

API	标题	API概述
在线表配置	在线表配置
GetIndexOnlineStrategy	获取某一索引在线策略	获取索引在线生效策略。
ModifyIndexOnlineStrategy	修改某一索引在线策略	修改索引在线策略。
ModifyOnlineConfig	修改在线表配置	修改在线表配置。
ListOnlineConfigs	获取在线表配置的详情	获取在线表配置的详情。
索引结构	索引结构
ModifyIndex	修改索引	修改索引。
StartIndex	恢复使用索引	恢复使用索引。
StopIndex	停止使用索引	停止使用索引。
CreateIndex	创建索引信息	创建索引信息。
BuildIndex	触发索引重建	触发索引重建。
DeleteIndexVersion	删除索引的版本	删除索引的版本。
DeleteIndex	删除索引	删除索引。
ModifyIndexVersion	修改集群索引版本（索引回滚）	修改集群索引版本（索引回滚）。
ModifyFile	修改文件	修改文件。
PublishIndexVersion	发布索引版本	发布索引版本。
ModifyIndexPartition	修改索引分区信息	快速扩缩列。
GetIndex	查看索引表详情	查看索引表版本详情。
GetIndexVersion	获取集群可回滚的索引信息	获取集群可回滚的索引信息。
GetFile	查看索引表版本详情	查看索引表版本详情。
ListIndexes	获取索引列表	获取索引列表。
RecoverIndex	从索引中恢复数据	从索引中恢复数据。
高级配置	高级配置
CreateConfigDir	高级配置创建文件目录	高级配置创建文件目录。
CreateConfigFile	高级配置创建文件	高级配置创建文件。
DeleteConfigDir	删除高级配置目录	删除高级配置目录。
DeleteConfigFile	删除高级配置文件	删除高级配置文件。
ModifyAdvanceConfig	修改http、git类型的文件内容	修改http、git类型的文件内容。
DeleteAdvanceConfig	删除高级配置的详情	删除高级配置的详情。
ModifyAdvanceConfigFile	修改词典	修改词典。
PublishAdvanceConfig	发布高级版本	发布高级版本。
GetAdvanceConfig	获取词典信息	获取词典信息。
GetAdvanceConfigFile	获取词典信息	获取词典信息。
ListAdvanceConfigDir	获取高级配置目录下文件列表	获取高级配置目录下文件列表。
ListAdvanceConfigs	获取高级配置列表	获取高级配置列表。
数据源配置	数据源配置
ListSchemas	根据数据同步配置获取schema信息	根据数据同步配置获取schema信息。
ModifyDataSourceDeploy	修改数据源部署信息	修改数据源部署信息。
CreateDataSource	创建数据源	创建数据源。
DeleteDataSource	删除数据源	删除数据源。
GetDataSource	获取某一数据源	获取某一数据源。
ListDataSources	获取数据源列表	获取数据源列表。
ListDataSourceSchemas	获取某一数据源的schema信息	获取某一数据源的schema信息。
ListDateSourceGenerations	获取数据源的历史回流信息	获取数据源的历史回流信息。
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	获取实例的变更历史	获取实例的变更历史。
ListClusterTasks	展示集群任务	展示集群任务。
ListDataSourceTasks	展示数据源任务	展示数据源任务。
StopTask	停止fsm任务	停止fsm任务。
ForceSwitch	强制切换	强制切换。
日志管理	日志管理
ListLogs	查询实例日志	查询实例日志。
部署管理	部署管理
ModifyNodeConfig	修改节点配置	修改节点配置。
GetDeployGraph	展示部署全局概览	展示部署全局概览。
GetNodeConfig	获取节点配置信息	获取节点配置信息。
运维管理	运维管理
ListIndexRecoverRecords	获取恢复数据记录	获取恢复数据记录。
ListPausePolicys	获取暂停策略	获取暂停策略。
ModifyPausePolicy	修改暂停开关	修改暂停开关。
CreateCluster	添加集群	添加集群。
RemoveCluster	删除某一集群	删除某一集群。
ModifyClusterDesc	更改集群的描述信息	更改集群的描述信息。
ModifyClusterOfflineConfig	修改集群的配置信息	修改集群的配置信息。
ModifyClusterOnlineConfig	修改集群的在线配置信息	修改集群的在线配置信息。
GetCluster	获取某一集群的详细信息	获取某一集群的详细信息。
GetClusterRunTimeInfo	获取集群信息	获取集群信息。
ListClusterNames	获取集群可选择的名称	获取集群可选择的名称。
ListClusters	获取集群列表	获取集群列表。

表管理

API	标题	API概述
表别名管理	表别名管理
ModifyAlias	修改表别名	修改表别名。
ListAliases	查询表别名列表	查询表别名列表。
DeleteAlias	删除别名	删除别名。
CreateAlias	创建别名	创建别名。
CreateTable	创建索引表	创建索引表。
ModifyTable	修改索引表	修改索引表。
GetTable	获取索引表信息	获取索引表信息。
ListTables	获取索引列表	获取索引列表。
DeleteTable	删除索引表	删除索引表。
Reindex	重建索引	重建索引。
ListTableGenerations	获取索引generation列表	获取索引generation列表。
GetTableGeneration	根据generationId获取某个索引版本状态	根据generationId获取某个索引版本状态。

其他

API	标题	API概述
ListPostQueryResult	召回引擎版使用POST请求获取搜索测试结果	召回引擎版使用POST请求获取搜索测试结果。
ListRestQueryResult	召回引擎版获取rest查询搜索测试结果	召回引擎版获取rest查询搜索测试结果。
ListVectorQueryResult	向量检索版获取向量查询搜索测试结果	向量检索版获取向量查询搜索测试结果。
PushDocuments	推送数据	推送数据。
DescribeRegions	获取云产品区域列表	获取云产品区域列表。
ListQueryResult	获取搜索测试结果	获取搜索测试结果。
DeleteModel	删除模型	删除模型。
ModifyModel	修改模型	修改模型详情，修改模型状态。
DebugModel	模型调试	调试模型。
GetModel	获取模型详细信息	通过实例ID和模型名称查询特定模型的详细配置信息。
ListModels	模型列表	通过实例ID查询指定条件下的模型列表。
CreateModel	创建模型	创建模型信息。
ModifySearcherReplica	修改数据节点副本分片数	通过指定实例ID来修改数据节点的副本或分片数量。