API概览 - 智能开放搜索 OpenSearch

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

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

应用实例

API	标题	API概述
应用管理	应用管理
RenewAppGroup	为应用续费（暂不支持）	为应用续费（续费暂不支持API调用，请在控制台操作续费）。
CreateAppGroup	创建一个应用	创建一个OpenSearch应用。
ModifyAppGroup	修改应用属性或设置应用在线版本	修改 OpenSearch 应用属性或设置应用在线版本。
ModifyAppGroupQuota	修改应用配额	修改 OpenSearch 应用配额。
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	创建 ABTest 实验场景	创建实验场景。
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脚本
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	更新算法实例	根据实例名称更新实例信息。
CreateFunctionInstance	创建算法实例	创建指定功能的一个算法实例。

其它(未在目录中的文档)

API	标题	API概述
DescribeAppGroup	查看应用实例详情	查看一个 OpenSearch 应用详情。
ValidateDataSources	验证数据源	验证数据源。
ReplaceAppGroupCommodityCode	应用服务型转实例型	应用服务型转实例型。
ListSortScripts	获取指定版本下所有的排序脚本	获取指定版本下所有的排序脚本。
ListDataSourceTables	获取指定实例的数据源列表	获取指定数据源的所有数据。
ListDataSourceTableFields	获取指定数据表的所有字段	获取指定数据表的所有字段，为内部接口。
GetDomain	获取行业类型	获取行业类型。
GenerateMergedTable	获取合并后的宽表	获取合并后的宽表。
DescribeRegions	查询可以使用的阿里云地域	获取所有区域的接入地址。

其他

API	标题	API概述
DescribeDataCollction	DescribeDataCollection	获取指定应用的数据采集详情。
ListDataCollections	ListDataCollections	获取OpenSearch应用的数据采集清单。
RemoveDataCollection	RemoveDataCollection	关闭数据采集。
UntagResources	删除标签	删标签接口。
ListTagResources	查标签列表	查标签接口。
TagResources	为实例打标签	打标签接口。
GetFunctionResource	获取算法资源	获取指定名称的算法资源。
ListFunctionResources	获取算法资源列表	获取算法资源列表。
DeleteFunctionResource	删除算法资源	删除指定算法资源。
UpdateFunctionResource	更新算法资源	更新算法资源。
CreateAppGroupCredentials	创建应用组凭据	按需创建指定应用组的访问凭据，支持dryRun模式预览操作。