All Products
Search

This Product

    OpenSearch:List of operations by function

    Document Center

    OpenSearch:List of operations by function

    Last Updated:Dec 06, 2024
    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

    APITitleDescription
    ChangeResourceGroupChangeResourceGroup
    CreatePublicUrlCreatePublicUrlCreates a public endpoint.
    DeletePublicUrlDeletePublicUrlDeletes a public endpoint.
    ModifyPublicUrlIpListModifyPublicUrlIpList
    CreateInstanceCreateInstanceCreates a Havenask instance.
    DeleteInstanceDeleteInstanceDeletes a specified instance.
    UpdateInstanceUpdateInstanceModifies the configuration of a specified instance.
    ModifyPasswordModifyPasswordChanges the password of an instance.
    ListInstancesListInstancesQueries a list of instances.
    GetInstanceGetInstanceQueries the details of an instance based on the instance ID.
    ListInstanceSpecsListInstanceSpecsQueries the specifications of an instance.

    The configuration center

    APITitleDescription
    Online table configurationOnline table configuration
    GetIndexOnlineStrategyGetIndexOnlineStrategyQueries the online effective policy of an index.
    ModifyIndexOnlineStrategyModifyIndexOnlineStrategyModifies the online policy of an index.
    ModifyOnlineConfigModifyOnlineConfigModifies online configurations.
    ListOnlineConfigsListOnlineConfigsQueries the details of an online configuration.
    Index structureIndex structure
    ModifyIndexModifyIndex
    StartIndexStartIndex
    StopIndexStopIndex
    CreateIndexCreateIndexCreates an index.
    BuildIndexBuildIndexTriggers reindexing.
    DeleteIndexVersionDeleteIndexVersionDeletes the version of an index.
    DeleteIndexDeleteIndexDeletes an index.
    ModifyIndexVersionModifyIndexVersionModifies the index version of a cluster (an index version rollback).
    ModifyFileModifyFileModifies a file.
    PublishIndexVersionPublishIndexVersionPublishes a specified index version.
    ModifyIndexPartitionModifyIndexPartitionModifies the information about index partitions.
    GetIndexGetIndexQueries the information about an index version.
    GetIndexVersionGetIndexVersionQueries the information about index versions that the current index version can be rolled back to.
    GetFileGetFileQueries the details of an index table version.
    ListIndexesListIndexesObtains the index list.
    RecoverIndexRecoverIndexRestores data from an index.
    Advanced ConfigurationAdvanced Configuration
    CreateConfigDirCreate Advanced configuration file directories
    CreateConfigFileCreateConfigFile
    DeleteConfigDirDeleteConfigDir
    DeleteConfigFileDeleteConfigFile
    ModifyAdvanceConfigModifyAdvanceConfig
    DeleteAdvanceConfigDeleteAdvanceConfigDeletes the details about advanced configurations.
    ModifyAdvanceConfigFileModifyAdvanceConfigFileModifies the advanced configurations.
    PublishAdvanceConfigPublishAdvanceConfigPublishes a version of advanced configurations.
    GetAdvanceConfigGetAdvanceConfigQueries the information about an advanced configuration.
    GetAdvanceConfigFileGetAdvanceConfigFileQueries the information about an advanced configuration file.
    ListAdvanceConfigDirListAdvanceConfigDirQueries the files in an advanced configuration directory.
    ListAdvanceConfigsListAdvanceConfigsObtains a list of advanced configurations.
    Data source configurationData source configuration
    ListSchemasListSchemas
    ModifyDataSourceDeployModifyDataSourceDeploy
    CreateDataSourceCreateDataSourceCreates data sources.
    DeleteDataSourceDeleteDataSourceDeletes a specified data source.
    GetDataSourceGetDataSourceObtains a data source.
    ListDataSourcesListDataSourcesObtains the list of data sources.
    ListDataSourceSchemasListDataSourceSchemasQueries the schema information about a data source.
    ListDateSourceGenerationsListDateSourceGenerationsQueries the historical index versions of a data source.
    GetDataSourceDeployGetDataSourceDeploy

    Operation and Maintenance Center

    APITitleDescription
    SQL developmentSQL development
    CreateFolderCreateFolderCreates a folder.
    DeleteSqlInstanceDeleteSqlInstance
    DeleteFolderDeleteFolder
    Change historyChange history
    ListTasksListTasks
    ListClusterTasksListClusterTasksQueries cluster tasks.
    ListDataSourceTasksListDataSourceTasksDisplays data source tasks.
    StopTaskStopTaskStops an FSM task.
    ForceSwitchForceSwitchPerforms a forced switchover.
    Log ManagementLog Management
    ListLogsListLogs
    Deployment ManagementDeployment Management
    ModifyNodeConfigModifyNodeConfigModifies the configurations of a node.
    GetDeployGraphGetDeployGraphDisplays the overview of the deployment.
    GetNodeConfigGetNodeConfigGets the configuration information of a node.
    Operation and Maintenance ManagementOperation and Maintenance Management
    ListIndexRecoverRecordsListIndexRecoverRecords
    ListPausePolicysListPausePolicys
    ModifyPausePolicyModifyPausePolicy
    CreateClusterCreateClusterCreates a cluster.
    RemoveClusterRemoveClusterDeletes a cluster.
    ModifyClusterDescModifyClusterDescModifies the description of a specified cluster.
    ModifyClusterOfflineConfigModifyClusterOfflineConfigModifies the configuration information of a cluster.
    ModifyClusterOnlineConfigModifyClusterOnlineConfigModifies the online configuration of a cluster.
    GetClusterGetClusterQueries the details of a cluster.
    GetClusterRunTimeInfoGetClusterRunTimeInfoQueries the runtime information about a specified cluster.
    ListClusterNamesListClusterNamesQueries cluster names.
    ListClustersListClustersQueries clusters.

    Table Management

    APITitleDescription
    Table Alias ManagementTable Alias Management
    ModifyAliasModifyAlias
    ListAliasesListAliases
    DeleteAliasDeleteAlias
    CreateAliasCreateAlias
    CreateTableCreateTableCreates an index table.
    ModifyTableModifyTableModifies an index table.
    GetTableGetTableQueries the information about an index table.
    ListTablesListTablesQueries a list of index tables.
    DeleteTableDeleteTableDeletes an index table.
    ReindexReindexRebuilds an index.
    ListTableGenerationsListTableGenerationsQueries a list of index versions.
    GetTableGenerationGetTableGenerationQueries the status of an index version based on the ID of the full index version.

    Other

    APITitleDescription
    ListPostQueryResultListPostQueryResult
    ListRestQueryResultListRestQueryResult
    ListVectorQueryResultListVectorQueryResult
    PushDocumentsPushDocuments
    DescribeRegionsDescribeRegionsQueries available regions.
    ListQueryResultListQueryResultQueries the query result.