本产品（
开放搜索-问天引擎/2021-10-25）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
搜索测试
| API | 标题 | API概述 |
|---|---|---|
| ListQueryResult | 获取搜索测试结果 | 获取搜索测试结果。 |
实例详情
| API | 标题 | API概述 |
|---|---|---|
| CreateInstance | 创建实例 | 创建问天引擎实例。 |
| DeleteInstance | 删除实例 | 删除指定实例。 |
| UpdateInstance | 修改指定实例配置 | 修改指定实例配置。 |
| ModifyPassword | 修改实例的密码 | 修改实例的密码。 |
| ListInstances | 获取实例列表 | 获取实例列表。 |
| GetInstance | 通过指定的实例ID查看实例详情 | 通过指定的实例ID查看实例详情。 |
| ListInstanceSpecs | 获取集群可选择的规格列表 | 获取集群可选择的规格列表。 |
运维中心
| API | 标题 | API概述 |
|---|---|---|
| 运维管理 | 运维管理 | |
| CreateCluster | 添加集群 | 添加集群。 |
| RemoveCluster | 删除某一集群 | 删除某一集群。 |
| ModifyClusterDesc | 更改集群的描述信息 | 更改集群的描述信息。 |
| ModifyClusterOfflineConfig | 修改集群的配置信息 | 修改集群的配置信息。 |
| ModifyClusterOnlineConfig | 修改集群的在线配置信息 | 修改集群的在线配置信息。 |
| GetCluster | 获取某一集群的详细信息 | 获取某一集群的详细信息。 |
| GetClusterRunTimeInfo | 获取集群信息 | 获取集群信息。 |
| ListClusterNames | 获取集群可选择的名称 | 获取集群可选择的名称。 |
| ListClusters | 获取集群列表 | 获取集群列表。 |
| 部署管理 | 部署管理 | |
| ModifyNodeConfig | 修改节点配置 | 修改节点配置。 |
| GetDeployGraph | 展示部署全局概览 | 展示部署全局概览。 |
| GetNodeConfig | 获取节点配置信息 | 获取节点配置信息。 |
| 变更历史 | 变更历史 | |
| StopTask | 停止fsm任务 | 停止fsm任务。 |
| ForceSwitch | 强制切换 | 强制切换。 |
| ListClusterTasks | 展示集群任务 | 展示集群任务 。 |
| ListDataSourceTasks | 展示数据源任务 | 展示数据源任务。 |
配置中心
| API | 标题 | API概述 |
|---|---|---|
| 在线表配置 | 在线表配置 | |
| ModifyOnlineConfig | 修改在线表配置 | 修改在线表配置。 |
| ListOnlineConfigs | 获取在线表配置的详情 | 获取在线表配置的详情。 |
| 索引结构 | 索引结构 | |
| CreateIndex | 创建索引信息 | 创建索引信息。 |
| BuildIndex | 触发索引重建 | 触发索引重建。 |
| DeleteIndexVersion | 删除索引的版本 | 删除索引的版本。 |
| DeleteIndex | 删除索引 | 删除索引。 |
| ModifyIndexVersion | 修改集群索引版本（索引回滚） | 修改集群索引版本（索引回滚）。 |
| ModifyFile | 修改文件 | 修改文件。 |
| PublishIndexVersion | 发布索引版本 | 发布索引版本。 |
| ModifyIndexPartition | 修改索引分区信息 | 快速扩缩列。 |
| GetIndex | 获取集群可回滚的索引信息 | 查看索引表版本详情。 |
| GetIndexVersion | 获取集群可回滚的索引信息 | 获取集群可回滚的索引信息。 |
| GetFile | 查看索引表版本详情 | 查看索引表版本详情。 |
| ListIndexes | 获取索引列表 | 获取索引列表。 |
| RecoverIndex | 从索引中恢复数据 | 从索引中恢复数据。 |
| 高级配置 | 高级配置 | |
| DeleteAdvanceConfig | 删除高级配置的详情 | 删除高级配置的详情。 |
| ModifyAdvanceConfigFile | 修改词典 | 修改词典。 |
| PublishAdvanceConfig | 发布高级版本 | 发布高级版本。 |
| GetAdvanceConfig | 获取词典信息 | 获取词典信息。 |
| GetAdvanceConfigFile | 获取词典信息 | 获取词典信息。 |
| ListAdvanceConfigDir | 获取高级配置目录下文件列表 | 获取高级配置目录下文件列表。 |
| ListAdvanceConfigs | 获取高级配置列表 | 获取高级配置列表。 |
| 数据源配置 | 数据源配置 | |
| CreateDataSource | 创建数据源 | 创建数据源。 |
| DeleteDataSource | 删除数据源 | 删除数据源。 |
| ModifyDataSource | 修改数据源 | 修改数据源。 |
| GetDataSource | 获取某一数据源 | 获取某一数据源。 |
| ListDataSources | 获取数据源列表 | 获取数据源列表。 |
| ListDataSourceSchemas | 获取某一数据源的schema信息 | 获取某一数据源的schema信息。 |
| ListDateSourceGenerations | 获取数据源的历史回流信息 | 获取数据源的历史回流信息。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| GetDataSourceDeploy | GetDataSourceDeploy |