This product(
searchengine/2021-10-25
) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
The instance details
API | Title | Description |
---|---|---|
ChangeResourceGroup | ChangeResourceGroup | |
CreatePublicUrl | CreatePublicUrl | Creates a public endpoint. |
DeletePublicUrl | DeletePublicUrl | Deletes a public endpoint. |
ModifyPublicUrlIpList | ModifyPublicUrlIpList | |
CreateInstance | CreateInstance | Creates a Havenask instance. |
DeleteInstance | DeleteInstance | Deletes a specified instance. |
UpdateInstance | UpdateInstance | Modifies the configuration of a specified instance. |
ModifyPassword | ModifyPassword | Changes the password of an instance. |
ListInstances | ListInstances | Queries a list of instances. |
GetInstance | GetInstance | Queries the details of an instance based on the instance ID. |
ListInstanceSpecs | ListInstanceSpecs | Queries the specifications of an instance. |
The configuration center
API | Title | Description |
---|---|---|
Online table configuration | Online table configuration | |
GetIndexOnlineStrategy | GetIndexOnlineStrategy | Queries the online effective policy of an index. |
ModifyIndexOnlineStrategy | ModifyIndexOnlineStrategy | Modifies the online policy of an index. |
ModifyOnlineConfig | ModifyOnlineConfig | Modifies online configurations. |
ListOnlineConfigs | ListOnlineConfigs | Queries the details of an online configuration. |
Index structure | Index structure | |
ModifyIndex | ModifyIndex | |
StartIndex | StartIndex | |
StopIndex | StopIndex | |
CreateIndex | CreateIndex | Creates an index. |
BuildIndex | BuildIndex | Triggers reindexing. |
DeleteIndexVersion | DeleteIndexVersion | Deletes the version of an index. |
DeleteIndex | DeleteIndex | Deletes an index. |
ModifyIndexVersion | ModifyIndexVersion | Modifies the index version of a cluster (an index version rollback). |
ModifyFile | ModifyFile | Modifies a file. |
PublishIndexVersion | PublishIndexVersion | Publishes a specified index version. |
ModifyIndexPartition | ModifyIndexPartition | Modifies the information about index partitions. |
GetIndex | GetIndex | Queries the information about an index version. |
GetIndexVersion | GetIndexVersion | Queries the information about index versions that the current index version can be rolled back to. |
GetFile | GetFile | Queries the details of an index table version. |
ListIndexes | ListIndexes | Obtains the index list. |
RecoverIndex | RecoverIndex | Restores data from an index. |
Advanced Configuration | Advanced Configuration | |
CreateConfigDir | Create Advanced configuration file directories | |
CreateConfigFile | CreateConfigFile | |
DeleteConfigDir | DeleteConfigDir | |
DeleteConfigFile | DeleteConfigFile | |
ModifyAdvanceConfig | ModifyAdvanceConfig | |
DeleteAdvanceConfig | DeleteAdvanceConfig | Deletes the details about advanced configurations. |
ModifyAdvanceConfigFile | ModifyAdvanceConfigFile | Modifies the advanced configurations. |
PublishAdvanceConfig | PublishAdvanceConfig | Publishes a version of advanced configurations. |
GetAdvanceConfig | GetAdvanceConfig | Queries the information about an advanced configuration. |
GetAdvanceConfigFile | GetAdvanceConfigFile | Queries the information about an advanced configuration file. |
ListAdvanceConfigDir | ListAdvanceConfigDir | Queries the files in an advanced configuration directory. |
ListAdvanceConfigs | ListAdvanceConfigs | Obtains a list of advanced configurations. |
Data source configuration | Data source configuration | |
ListSchemas | ListSchemas | |
ModifyDataSourceDeploy | ModifyDataSourceDeploy | |
CreateDataSource | CreateDataSource | Creates data sources. |
DeleteDataSource | DeleteDataSource | Deletes a specified data source. |
GetDataSource | GetDataSource | Obtains a data source. |
ListDataSources | ListDataSources | Obtains the list of data sources. |
ListDataSourceSchemas | ListDataSourceSchemas | Queries the schema information about a data source. |
ListDateSourceGenerations | ListDateSourceGenerations | Queries the historical index versions of a data source. |
GetDataSourceDeploy | GetDataSourceDeploy |
Operation and Maintenance Center
API | Title | Description |
---|---|---|
SQL development | SQL development | |
CreateFolder | CreateFolder | Creates a folder. |
DeleteSqlInstance | DeleteSqlInstance | |
DeleteFolder | DeleteFolder | |
Change history | Change history | |
ListTasks | ListTasks | |
ListClusterTasks | ListClusterTasks | Queries cluster tasks. |
ListDataSourceTasks | ListDataSourceTasks | Displays data source tasks. |
StopTask | StopTask | Stops an FSM task. |
ForceSwitch | ForceSwitch | Performs a forced switchover. |
Log Management | Log Management | |
ListLogs | ListLogs | |
Deployment Management | Deployment Management | |
ModifyNodeConfig | ModifyNodeConfig | Modifies the configurations of a node. |
GetDeployGraph | GetDeployGraph | Displays the overview of the deployment. |
GetNodeConfig | GetNodeConfig | Gets the configuration information of a node. |
Operation and Maintenance Management | Operation and Maintenance Management | |
ListIndexRecoverRecords | ListIndexRecoverRecords | |
ListPausePolicys | ListPausePolicys | |
ModifyPausePolicy | ModifyPausePolicy | |
CreateCluster | CreateCluster | Creates a cluster. |
RemoveCluster | RemoveCluster | Deletes a cluster. |
ModifyClusterDesc | ModifyClusterDesc | Modifies the description of a specified cluster. |
ModifyClusterOfflineConfig | ModifyClusterOfflineConfig | Modifies the configuration information of a cluster. |
ModifyClusterOnlineConfig | ModifyClusterOnlineConfig | Modifies the online configuration of a cluster. |
GetCluster | GetCluster | Queries the details of a cluster. |
GetClusterRunTimeInfo | GetClusterRunTimeInfo | Queries the runtime information about a specified cluster. |
ListClusterNames | ListClusterNames | Queries cluster names. |
ListClusters | ListClusters | Queries clusters. |
Table Management
API | Title | Description |
---|---|---|
Table Alias Management | Table Alias Management | |
ModifyAlias | ModifyAlias | |
ListAliases | ListAliases | |
DeleteAlias | DeleteAlias | |
CreateAlias | CreateAlias | |
CreateTable | CreateTable | Creates an index table. |
ModifyTable | ModifyTable | Modifies an index table. |
GetTable | GetTable | Queries the information about an index table. |
ListTables | ListTables | Queries a list of index tables. |
DeleteTable | DeleteTable | Deletes an index table. |
Reindex | Reindex | Rebuilds an index. |
ListTableGenerations | ListTableGenerations | Queries a list of index versions. |
GetTableGeneration | GetTableGeneration | Queries the status of an index version based on the ID of the full index version. |
Other
API | Title | Description |
---|---|---|
ListPostQueryResult | ListPostQueryResult | |
ListRestQueryResult | ListRestQueryResult | |
ListVectorQueryResult | ListVectorQueryResult | |
PushDocuments | PushDocuments | |
DescribeRegions | DescribeRegions | Queries available regions. |
ListQueryResult | ListQueryResult | Queries the query result. |