API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (searchengine/2021-10-25) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
The instance details
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of an instance. |
| TagResources | TagResources | Adds or updates tags for multiple resources. |
| UntagResources | UntagResources | Removes tags from a batch of resources. |
| ListTagResources | ListTagResources | Queries the tags attached to one or more resources. |
| CreatePublicUrl | CreatePublicUrl | Creates a public endpoint. |
| DeletePublicUrl | DeletePublicUrl | Deletes a public endpoint. |
| ModifyPublicUrlIpList | ModifyPublicUrlIpList | You can modify the public domain name whitelist. |
| 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 | Retrieves a list of instances. |
| GetInstance | GetInstance | Retrieves the details of an instance by specifying its 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 | Modifies an index. |
| StartIndex | StartIndex | Resumes an index. |
| StopIndex | StopIndex | Stops an index. |
| CreateIndex | CreateIndex | Creates an index. |
| BuildIndex | BuildIndex | Rebuilds an index. |
| 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 | Retrieves the details of an index table 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 | Retrieves a list of indexes. |
| RecoverIndex | RecoverIndex | Restores data from an index. |
| Advanced Configuration | Advanced Configuration | |
| CreateConfigDir | Create Advanced configuration file directories | Creates a directory for an advanced configuration. |
| CreateConfigFile | CreateConfigFile | Creates a configuration file in an advanced configuration. |
| DeleteConfigDir | DeleteConfigDir | Deletes an advanced configuration directory. |
| DeleteConfigFile | DeleteConfigFile | Deletes an advanced configuration file. |
| ModifyAdvanceConfig | ModifyAdvanceConfig | Modifies the content of HTTP or Git files. |
| 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 | Retrieves a list of advanced configurations. |
| Data source configuration | Data source configuration | |
| ListSchemas | ListSchemas | Retrieves a list of schemas based on a data synchronization configuration. |
| ModifyDataSourceDeploy | ModifyDataSourceDeploy | Modifies the deployment information of a data source. |
| 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 | Retrieves the deployment information for a data source. |
Operation and Maintenance Center
|
API |
Title |
Description |
| SQL development | SQL development | |
| CloneSqlInstance | CloneSqlInstance | Clones an SQL instance. |
| CreateFolder | CreateFolder | Creates a folder. |
| CreateSqlInstance | CreateSqlInstance | Creates an SQL instance. |
| DeleteSqlInstance | DeleteSqlInstance | Deletes an SQL instance. |
| ExecuteSqlInstance | ExecuteSqlInstance | Executes an SQL instance. |
| GetDatabaseSchema | GetDatabaseSchema | Retrieves the schema of a database. |
| GetSqlInstance | GetSqlInstance | Retrieves information about an SQL instance. |
| ListDatabases | ListDatabases | Lists existing databases. |
| UpdateSqlInstanceContent | UpdateSqlInstanceContent | Updates the content of an SQL instance. |
| UpdateSqlInstanceName | UpdateSqlInstanceName | Updates the name of an SQL instance. |
| UpdateSqlInstanceParams | UpdateSqlInstanceParams | Updates the parameters of an SQL instance. |
| DeleteFolder | DeleteFolder | Deletes a folder. |
| RenameFolder | RenameFolder | Renames a folder. |
| Change history | Change history | |
| ListTasks | ListTasks | Retrieves the change history for an instance. |
| 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 | Queries the logs of an instance. |
| 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 | Lists data recovery records. |
| ListPausePolicys | ListPausePolicys | Queries pause policies. |
| ModifyPausePolicy | ModifyPausePolicy | Modifies the pause policy. |
| 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 | Modifies a table alias. |
| ListAliases | ListAliases | Lists table aliases. |
| DeleteAlias | DeleteAlias | Deletes an alias. |
| CreateAlias | CreateAlias | Creates an alias. |
| CreateTable | CreateTable | Creates an index table. |
| ModifyTable | ModifyTable | Modifies an index table. |
| GetTable | GetTable | Retrieves 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 | Retrieves the results of a search test for a Retrieval-Augmented Generation Edition instance by sending a POST request. |
| ListRestQueryResult | ListRestQueryResult | Retrieves the test results of a REST search query for a Retrieval Engine Edition instance. |
| ListVectorQueryResult | ListVectorQueryResult | Retrieves the results of a vector query test in Vector Search Edition. |
| PushDocuments | PushDocuments | Pushes documents. |
| DescribeRegions | DescribeRegions | Queries available regions. |
| ListQueryResult | ListQueryResult | Queries the query result. |
| DeleteModel | DeleteModel | Deletes a model. |
| ModifyModel | ModifyModel | Modifies the details and status of a model. |
| DebugModel | DebugModel | Debugs a model. |
| GetModel | GetModel | Queries the detailed configuration of a specific model by instance ID and model name. |
| ListModels | ListModels | Queries for models in an instance that meet specified criteria. |
| CreateModel | CreateModel | Creates a model. |
| ModifySearcherReplica | ModifySearcherReplica | Modifies the number of replicas or shards for data nodes in an instance. |