文档

API概览

本产品(智能开放搜索 OpenSearch/2017-12-25)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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接收自定义分析器词条变更接收自定义分析器词条变更。
ABTestABTest
实验场景实验场景
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概述
DescribeDataCollctionDescribeDataCollection获取指定应用的数据采集详情。
ListDataCollectionsListDataCollections获取OpenSearch应用的数据采集清单。
RemoveDataCollectionRemoveDataCollection关闭数据采集。
UntagResourcesUntagResources删标签接口。
ListTagResourcesListTagResources查标签接口。
TagResourcesTagResources打标签接口。
GetFunctionResource获取算法资源获取指定名称的算法资源。
ListFunctionResources获取算法资源列表获取算法资源列表。
DeleteFunctionResource删除算法资源删除指定算法资源。
UpdateFunctionResource更新算法资源更新算法资源。
  • 本页导读 (0)