文档

API概览

更新时间:
本产品(开放搜索-问天引擎/2021-10-25)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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类型的文件内容
DeleteAdvanceConfig删除高级配置的详情删除高级配置的详情。
ModifyAdvanceConfigFile修改词典修改词典。
PublishAdvanceConfig发布高级版本发布高级版本。
GetAdvanceConfig获取词典信息获取词典信息。
GetAdvanceConfigFile获取词典信息获取词典信息。
ListAdvanceConfigDir获取高级配置目录下文件列表获取高级配置目录下文件列表。
ListAdvanceConfigs获取高级配置列表获取高级配置列表。
数据源配置数据源配置
ListSchemas根据数据同步配置获取schema信息
ModifyDataSourceDeploy修改数据源部署信息
CreateDataSource创建数据源创建数据源。
DeleteDataSource删除数据源删除数据源。
GetDataSource获取某一数据源获取某一数据源。
ListDataSources获取数据源列表获取数据源列表。
ListDataSourceSchemas获取某一数据源的schema信息获取某一数据源的schema信息。
ListDateSourceGenerations获取数据源的历史回流信息获取数据源的历史回流信息。
GetDataSourceDeploy获取数据源部署信息

运维中心

API标题API概述
运维管理运维管理
ListIndexRecoverRecords获取恢复数据记录
ListPausePolicys获取暂停策略
ModifyPausePolicy修改暂停开关
CreateCluster添加集群添加集群。
RemoveCluster删除某一集群删除某一集群。
ModifyClusterDesc更改集群的描述信息更改集群的描述信息。
ModifyClusterOfflineConfig修改集群的配置信息修改集群的配置信息。
ModifyClusterOnlineConfig修改集群的在线配置信息修改集群的在线配置信息。
GetCluster获取某一集群的详细信息获取某一集群的详细信息。
GetClusterRunTimeInfo获取集群信息获取集群信息。
ListClusterNames获取集群可选择的名称获取集群可选择的名称。
ListClusters获取集群列表获取集群列表。
部署管理部署管理
ModifyNodeConfig修改节点配置修改节点配置。
GetDeployGraph展示部署全局概览展示部署全局概览。
GetNodeConfig获取节点配置信息获取节点配置信息。
变更历史变更历史
ListTasks获取实例的变更历史
ListClusterTasks展示集群任务展示集群任务 。
ListDataSourceTasks展示数据源任务展示数据源任务。
StopTask停止fsm任务停止fsm任务。
ForceSwitch强制切换强制切换。
日志管理日志管理
ListLogs查询实例日志
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修改目录名称修改目录名称。

表管理

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

其他

API标题API概述
ListPostQueryResult召回引擎版使用POST请求获取搜索测试结果
ListRestQueryResult召回引擎版获取rest查询搜索测试结果
ListVectorQueryResult向量检索版获取向量查询搜索测试结果
PushDocuments推送数据
DescribeRegions获取云产品区域列表获取云产品区域列表
ListQueryResult获取搜索测试结果获取搜索测试结果。