All Products
Search

This Product

    OpenSearch:API overview

    Document Center

    OpenSearch:API overview

    Last Updated:Sep 11, 2026

    API standards and multilingual preset SDKs

    The OpenAPI of this product (searchengine/2021-10-25) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

    Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

    Custom signature scenarios

    If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

    Account and security preparation

    Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

    Instances

    API

    Title

    Description
    CreatePublicUrl Enable public domain name Enables the public domain name.
    DeletePublicUrl Delete a public domain name Deletes a public domain name.
    ModifyPublicUrlIpList Modify public domain name whitelist Modifies the public domain name whitelist.
    ModifyPassword Modify instance password Modifies the password of an instance.
    ListInstanceSpecs ListInstanceSpecs Queries the specifications of an instance.

    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 Query an online configuration.
    Index structure Index structure
    ModifyIndex Modify an index Modifies an index.
    StartIndex StartIndex Resumes an index.
    StopIndex StopIndex Stops an index.
    BuildIndex BuildIndex Rebuilds 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.
    GetIndexVersion GetIndexVersion Queries the information about index versions that the current index version can be rolled back to.
    ListIndexes ListIndexes Retrieves a list of indexes.
    RecoverIndex Recover data from an index Recovers data from an index.
    Advanced configuration Advanced configuration
    CreateConfigDir Create a file directory in an advanced configuration Creates a file directory in an advanced configuration.
    DeleteConfigDir Delete an advanced configuration folder Deletes an advanced configuration folder.
    ModifyAdvanceConfig ModifyAdvanceConfig Modifies the content of HTTP or Git files.
    DeleteAdvanceConfig DeleteAdvanceConfig Deletes the details about advanced configurations.
    ModifyAdvanceConfigFile Modify a dictionary Modifies a dictionary.
    PublishAdvanceConfig Publish an advanced version Publishes an advanced version.
    GetAdvanceConfig GetAdvanceConfig Queries the information about an advanced configuration.
    GetAdvanceConfigFile GetAdvanceConfigFile Queries the information about an advanced configuration file.
    ListAdvanceConfigDir Retrieve the list of files in an advanced configuration directory Retrieves the list of files in an advanced configuration directory.
    ListAdvanceConfigs ListAdvanceConfigs Retrieves a list of advanced configurations.
    Datasource config Datasource config
    ModifyDataSourceDeploy Modify data source deployment information Modifies the deployment information of a data source.
    ListDataSourceSchemas ListDataSourceSchemas Queries the schema information about a data source.
    ListDateSourceGenerations Retrieve historical data backflow information of a data source Retrieves the historical data backflow information of a data source.
    GetDataSourceDeploy GetDataSourceDeploy Retrieves the deployment information for a data source.

    O&M center

    API

    Title

    Description
    SQL development SQL development
    CloneSqlInstance Clone SQL Instance Clones an SQL instance.
    DeleteSqlInstance DeleteSqlInstance Deletes an SQL instance.
    ExecuteSqlInstance Execute a SQL instance Executes a SQL instance.
    GetDatabaseSchema GetDatabaseSchema Retrieves the schema of a database.
    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.
    RenameFolder RenameFolder Renames a folder.
    Release notes Release notes
    ListClusterTasks ListClusterTasks Queries cluster tasks.
    ListDataSourceTasks ListDataSourceTasks Displays data source tasks.
    ForceSwitch ForceSwitch Performs a forced switchover.
    Log management Log management
    ListLogs ListLogs Queries the logs of an instance.
    Deployment management Deployment management
    ModifyNodeConfig ModifyNodeConfig Modify a node.
    GetDeployGraph GetDeployGraph Displays the overview of the deployment.
    GetNodeConfig Retrieve node configuration information Retrieves the configuration information of a node.
    Operations management Operations management
    ListIndexRecoverRecords ListIndexRecoverRecords Lists data recovery records.
    ListPausePolicys ListPausePolicys Queries pause policies.
    ModifyPausePolicy ModifyPausePolicy Modifies the pause policy.
    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 Query a cluster.
    GetClusterRunTimeInfo GetClusterRunTimeInfo Queries the runtime information about a specified cluster.
    ListClusterNames ListClusterNames Queries cluster names.

    Table management

    API

    Title

    Description
    Table alias management Table alias management
    ModifyAlias ModifyAlias Modifies a table alias.
    CreateTable Create an index table Creates an index table.
    ModifyTable Modify an index table Modifies an index table.
    DeleteTable Delete Index Table Delete an index table.
    Reindex Rebuild an index 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.

    Others

    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.
    ListQueryResult ListQueryResult Queries the query result.
    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 List models Queries a list of models that meet specified conditions by instance ID.
    ModifySearcherReplica ModifySearcherReplica Modifies the number of replicas or shards for data nodes in an instance.
    ChangeResourceGroup ChangeResourceGroup Changes the resource group of an instance.
    CreateAlias Create an alias Creates an alias.
    CreateCluster Add a cluster Add a cluster.
    CreateConfigFile Create a file with advanced configurations Creates a file with advanced configurations.
    CreateDataSource Create a data source Creates a data source.
    CreateFolder Create a folder Creates a folder.
    CreateIndex CreateIndex Creates an index.
    CreateInstance Create an instance Creates a Wentian engine instance.
    CreateModel CreateModel Creates a model.
    CreateSqlInstance Create an SQL instance Creates an SQL instance.
    DeleteAlias Delete an alias Deletes an alias.
    DeleteConfigFile Delete an advanced configuration file Deletes an advanced configuration file.
    DeleteDataSource DeleteDataSource Deletes a specified data source.
    DeleteFolder DeleteFolder Deletes a folder.
    DeleteIndex DeleteIndex Deletes an index.
    DeleteIndexVersion DeleteIndexVersion Deletes the version of an index.
    DeleteInstance DeleteInstance Deletes a specified instance.
    DeleteModel DeleteModel Deletes a model.
    DescribeRegions DescribeRegions Queries available regions.
    GetDataSource GetDataSource Obtains a data source.
    GetFile GetFile Retrieves the details of an index version.
    GetIndex GetIndex Retrieves the details of an index table version.
    GetInstance GetInstance Retrieves the details of an instance by its ID.
    GetSqlInstance Retrieve SQL instance information Retrieves SQL instance information.
    GetTable Get Index Table Information Get index table information.
    ListAliases ListAliases Lists table aliases.
    ListClusters ListClusters Queries clusters.
    ListDatabases ListDatabases Lists the existing databases.
    ListDataSources ListDataSources Obtains the list of data sources.
    ListInstances ListInstances Retrieves a list of instances.
    ListSchemas ListSchemas Retrieves a list of schemas based on a data synchronization configuration.
    ListTables ListTables Queries a list of index tables.
    ListTagResources ListTagResources Queries the tags attached to one or more resources.
    ListTasks ListTasks Retrieves the change history for an instance.
    StopTask StopTask Stops an FSM task.
    TagResources TagResources Adds or updates tags for multiple resources.
    UntagResources UntagResources Removes tags from a batch of resources.
    UpdateInstance UpdateInstance Modifies the configuration of a specified instance.