API standards and multilingual preset SDKs
The OpenAPI of this product (OpenSearch/2017-12-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.
Application instances
|
API |
Title |
Description |
| Application management | Application management | |
| DescribeAppGroup | DescribeAppGroup | Query an OpenSearch application. |
| RenewAppGroup | RenewAppGroup | Renews an application. This API operation is unavailable. To renew an application, use the OpenSearch console. |
| CreateAppGroup | CreateAppGroup | Creates an OpenSearch application. |
| ModifyAppGroup | ModifyAppGroup | Modifies the properties of an OpenSearch application or sets its online version. |
| ModifyAppGroupQuota | ModifyAppGroupQuota | Modifies the quota of an OpenSearch application. |
| UpdateAppGroupDeleteProtection | UpdateAppGroupDeleteProtection | Updates the delete protection status for an application group. |
| RemoveAppGroup | RemoveAppGroup | Deletes an OpenSearch application. |
| ListAppGroups | ListAppGroups | Queries a list of OpenSearch applications. |
| Application versions | Application versions | |
| CreateApp | CreateApp | Creates a new version of an OpenSearch application. |
| RemoveApp | RemoveApp | Deletes a version of an OpenSearch application. |
| DescribeApps | DescribeApps | Queries the versions of an OpenSearch application. |
| DescribeApp | DescribeApp | Queries the information about a version of an OpenSearch application. |
Instance peripherals
|
API |
Title |
Description |
| Custom analyzers | Custom analyzers | |
| ListUserAnalyzers | ListUserAnalyzers | Retrieves a list of custom analyzers for your account. |
| CreateUserAnalyzer | Create Custom Analyzer | Creates a custom analyzer. |
| DescribeUserAnalyzer | DescribeUserAnalyzer | Retrieves the details of a custom analyzer. |
| ListUserAnalyzerEntries | ListUserAnalyzerEntries | Queries the entries of a custom analyzer. |
| PushUserAnalyzerEntries | PushUserAnalyzerEntries | Applies changes to the entries of a custom analyzer. |
| ABTest | ABTest | |
| Experiment scenarios | Experiment scenarios | |
| CreateABTestScene | CreateABTestScene | Creates an experiment scenario. |
| DescribeABTestScene | DescribeABTestScene | Query an A/B test scenario. |
| UpdateABTestScene | UpdateABTestScene | Modifies an experiment scenario. |
| DeleteABTestScene | DeleteABTestScene | Deletes an A/B test scenario. |
| Experiment groups | Experiment groups | |
| ListABTestGroups | ListABTestGroups | Retrieves a list of test groups. |
| CreateABTestGroup | CreateABTestGroup | Creates an experiment group. |
| DeleteABTestGroup | DeleteABTestGroup | Deletes an A/B test group. |
| DescribeABTestGroup | DescribeABTestGroup | Retrieves the details of an A/B test group. |
| UpdateABTestGroup | UpdateABTestGroup | Modifies a test group. |
| Experiments | Experiments | |
| CreateABTestExperiment | CreateABTestExperiment | Creates an experiment. |
| DescribeABTestExperiment | DescribeABTestExperiment | Retrieves the details of an experiment. |
| UpdateABTestExperiment | UpdateABTestExperiment | Updates the parameters of an A/B test experiment. |
| DeleteABTestExperiment | DeleteABTestExperiment | Deletes an experiment. |
| Whitelists | Whitelists | |
| ListABTestFixedFlowDividers | ListABTestFixedFlowDividers | Lists whitelists. |
| UpdateABTestFixedFlowDividers | UpdateABTestFixedFlowDividers | Updates the whitelist data. |
| Rough sort expressions | Rough sort expressions | |
| CreateFirstRank | CreateFirstRank | Creates a rough sort expression for a version of an OpenSearch application. If you set `dryRun` to true, this operation validates the specified rough sort expression. By default, the value of `dryRun` is `false`. |
| DescribeFirstRank | DescribeFirstRank | Queries the rough sort expression configured for an OpenSearch application version. |
| RemoveFirstRank | RemoveFirstRank | Deletes the rough sort configuration of an OpenSearch application version. |
| ModifyFirstRank | ModifyFirstRank | Modifies the rough sort expression for an OpenSearch application version. If you set the dryRun parameter to true, this operation validates the modified rough sort expression. The default value of this parameter is false. |
| Fine sort expressions | Fine sort expressions | |
| ListSecondRanks | ListSecondRanks | Lists the fine sort expressions for a specific version of an OpenSearch application. |
| CreateSecondRank | CreateSecondRank | Creates a fine sort expression for a version of an OpenSearch application. If you set the dryRun parameter to true, this operation validates the specified fine sort expression. The default value of this parameter is false. |
| DescribeSecondRank | DescribeSecondRank | Queries the fine sort expression for a version of an OpenSearch application. |
| ModifySecondRank | ModifySecondRank | Modifies a fine sort expression for an OpenSearch application version. If you set `dryRun` to `true`, the modified fine sort expression is validated. The `dryRun` parameter is `false` by default. |
| RemoveSecondRank | RemoveSecondRank | Deletes a fine sort expression from a version of an OpenSearch application. |
| Query analyzers | Query analyzers | |
| ListQueryProcessors | ListQueryProcessors | Queries a list of query analysis rules configured for a specific version of an OpenSearch application. |
| ModifyQueryProcessor | ModifyQueryProcessor | Modifies a query analysis rule for a specific application version. If you set the dryRun parameter to true, this operation checks the specified query analysis rule. If you do not specify the dryRun parameter, the default value is false. |
| RemoveQueryProcessor | RemoveQueryProcessor | Removes a query analysis rule from an OpenSearch application version. |
| DescribeQueryProcessor | DescribeQueryProcessor | Describes a query analysis rule for a version of an OpenSearch application. |
| ListQueryProcessorNers | ListQueryProcessorNers | Queries the recommended priority settings for entity types in Named Entity Recognition (NER). |
| ListQueryProcessorAnalyzerResults | ListQueryProcessorAnalyzerResults | Tests the results of query analysis. This operation can be called only for existing applications of the Open Source-compatible Edition. |
| Intervention dictionaries | Intervention dictionaries | |
| ListInterventionDictionaries | ListInterventionDictionaries | Retrieves a list of intervention dictionaries. |
| CreateInterventionDictionary | CreateInterventionDictionary | Creates an intervention dictionary. |
| DescribeInterventionDictionary | DescribeInterventionDictionary | Retrieves the details of an intervention dictionary. |
| RemoveInterventionDictionary | RemoveInterventionDictionary | Deletes an intervention dictionary. |
| ListInterventionDictionaryEntries | ListInterventionDictionaryEntries | Queries the intervention entries in an intervention dictionary. |
| PushInterventionDictionaryEntries | PushInterventionDictionaryEntries | Applies changes to intervention dictionary entries. |
| ListInterventionDictionaryRelatedEntities | ListInterventionDictionaryRelatedEntities | Queries the list of resources associated with an intervention dictionary. If a query processor (QP) references the dictionary, the operation returns all associated applications and information about the QP. |
| ListInterventionDictionaryNerResults | ListInterventionDictionaryNerResults | Retrieves the Named Entity Recognition (NER) results. |
| Optimization master | Optimization master | |
| EnableSlowQuery | EnableSlowQuery | Enables the slow query service for the optimizer. |
| DisableSlowQuery | DisableSlowQuery | Disables the slow query service for Search Diagnoser. |
| DescribeSlowQueryStatus | DescribeSlowQueryStatus | Queries the status of the slow query feature. |
| StartSlowQueryAnalyzer | StartSlowQueryAnalyzer | Starts a slow query analysis task. |
| ListSlowQueryQueries | ListSlowQueryQueries | Lists the slow queries from the Query Optimizer. |
| ListSlowQueryCategories | ListSlowQueryCategories | Lists the optimization suggestions for slow queries from Search Diagnosis. |
| Quota approval | Quota approval | |
| ListQuotaReviewTasks | ListQuotaReviewTasks | Lists the quota approval tickets for a specified OpenSearch application. |
| Scheduled tasks | Scheduled tasks | |
| ListScheduledTasks | ListScheduledTasks | Queries a list of scheduled tasks for an OpenSearch application. |
| CreateScheduledTask | CreateScheduledTask | Creates a scheduled task for an OpenSearch application. |
| DescribeScheduledTask | DescribeScheduledTask | Query a scheduled task for an OpenSearch application. |
| ModifyScheduledTask | ModifyScheduledTask | Modifies a scheduled task. |
| RemoveScheduledTask | RemoveScheduledTask | Deletes a scheduled task from an OpenSearch application. |
| Search policies | Search policies | |
| ListSortExpressions | ListSortExpressions | Lists the sort expressions that are configured for a version of an OpenSearch application. |
| Elasticsearch engine instances | Elasticsearch engine instances | |
| UnbindEsInstance | UnbindEsInstance | Unbinds an Elasticsearch instance from an OpenSearch application. |
| BindEsInstance | BindEsInstance | Binds an Elasticsearch instance as a dependency. |
| BindESUserAnalyzer | BindESUserAnalyzer | Binds a custom analyzer to an Elasticsearch instance. |
| UnbindESUserAnalyzer | UnbindESUserAnalyzer | Detaches a custom analyzer from an Elasticsearch instance. |
| Current processing flows | Current processing flows | |
| ListProceedings | ListProceedings | Lists the current proceedings. |
| Statistics | Statistics | |
| ListStatisticLogs | ListStatisticLogs | Queries log statistics, such as application error logs, hotword rankings, and slow query logs. |
| ListStatisticReport | ListStatisticReport | Queries statistical reports, such as application, drop-down suggestion, top search hint, A/B test, and data quality reports. |
| Cava scripts | Cava scripts | |
| ListSortScripts | ListSortScripts | Lists all sort scripts for a specified application version. |
| UpdateSortScript | UpdateSortScript | Modifies the description of a sort script. |
| ReleaseSortScript | ReleaseSortScript | Releases a sort script. |
| GetSortScriptFile | GetSortScriptFile | Retrieves the content of a sort script. |
| GetSortScript | GetSortScript | Retrieves the details of a sort script. |
| GetScriptFileNames | GetScriptFileNames | Retrieves the names of all files in a specified script for a specific application version. |
| DeleteSortScriptFile | DeleteSortScriptFile | Deletes a script file. |
| DeleteSortScript | DeleteSortScript | Deletes a sort script. |
| CreateSortScript | CreateSortScript | Creates a sort script. |
| CompileSortScript | CompileSortScript | Compiles a sort script. |
| Query policies | Query policies | |
| UpdateSearchStrategy | UpdateSearchStrategy | This operation supports dry runs. |
| RemoveSearchStrategy | RemoveSearchStrategy | Deletes a search strategy. |
| ListSearchStrategies | ListSearchStrategies | Retrieves the details of query policies. |
| GetSearchStrategy | GetSearchStrategy | Retrieves the details of a query policy. |
| CreateSearchStrategy | CreateSearchStrategy | Creates a search strategy. |
Version peripherals
|
API |
Title |
Description |
| Default display fields | Default display fields | |
| UpdateFetchFields | UpdateFetchFields | This operation supports dry runs. |
| Search result summaries | Search result summaries | |
| UpdateSummaries | UpdateSummaries | This operation supports dry runs. |
Algorithm peripherals
|
API |
Title |
Description |
| CreateFunctionResource | CreateFunctionResource | Creates an algorithm resource for a specified feature. |
| GetFunctionCurrentVersion | GetFunctionCurrentVersion | Retrieves the version information of the feature that is used to create an instance. |
| GetFunctionVersion | GetFunctionVersion | Queries the information about a function version. |
| GetFunctionDefaultInstance | GetFunctionDefaultInstance | Queries the default algorithm instance for an application. |
| UpdateFunctionDefaultInstance | UpdateFunctionDefaultInstance | Sets the default algorithm instance for the specified application. The new algorithm instance automatically overwrites the previously set default instance. If no instance is specified, the default instance is canceled. |
| ListFunctionTasks | ListFunctionTasks | Queries the training tasks. The results are sorted in descending order by start time. |
| GetFunctionTask | GetFunctionTask | Queries the details of a training task. |
| DeleteFunctionTask | DeleteFunctionTask | Deletes a training record. A training record that is in progress cannot be deleted. |
| CreateFunctionTask | CreateFunctionTask | Starts a training task. |
| ListFunctionInstances | ListFunctionInstances | Lists all instances that match the specified conditions. |
| GetFunctionInstance | GetFunctionInstance | Query an algorithm instance by instance name. |
| DeleteFunctionInstance | DeleteFunctionInstance | Deletes an algorithm instance. Before you delete an instance, ensure that it is not in use to prevent service interruptions. |
| UpdateFunctionInstance | UpdateFunctionInstance | Updates the configuration of a function instance. |
| GetFunctionResource | GetFunctionResource | Retrieves the specified algorithm resource. |
| ListFunctionResources | ListFunctionResources | Lists the algorithm resources. |
| DeleteFunctionResource | DeleteFunctionResource | Deletes a specified algorithm resource. |
| UpdateFunctionResource | UpdateFunctionResource | Updates an algorithm resource. |
| CreateFunctionInstance | CreateFunctionInstance | Creates an algorithm instance of a feature. |
Others (documents not in the directory)
|
API |
Title |
Description |
| ValidateDataSources | ValidateDataSources | Validates data sources. |
| ListDataSourceTables | ListDataSourceTables | Retrieves all data from a specified data source. |
| ListDataSourceTableFields | ListDataSourceTableFields | This internal API retrieves all fields from a specified data table. |
| GetDomain | GetDomain | Retrieves the industry type. |
| DescribeRegions | DescribeRegions | Retrieves the endpoints for all regions. |
Others
|
API |
Title |
Description |
| DescribeDataCollction | DescribeDataCollction | Retrieves the details of a data collection for a specified application. |
| ListDataCollections | ListDataCollections | Lists the data collections for an OpenSearch application. |
| RemoveDataCollection | RemoveDataCollection | Disables data collection. |
| UntagResources | UntagResources | Removes tags from resources. |
| ListTagResources | ListTagResources | Queries the tags of specified resources. |
| TagResources | TagResources | Adds tags to resources. |
| CreateAppGroupCredentials | CreateAppGroupCredentials | Creates access credentials for a specified application group. This operation supports a dry run to preview the results. |
| CreateQueryProcessor | CreateQueryProcessor | Creates a query analysis rule. If you set dryRun to true, this operation checks the specified query analysis rule. By default, the value of dryRun is false if you do not set this parameter. |
| DescribeAppStatistics | DescribeAppStatistics | Queries the statistics about a version of an OpenSearch application. |
| GenerateMergedTable | GenerateMergedTable | Queries the information about a wide table that is generated after a JOIN operation is performed on multiple tables. |
| ListABTestExperiments | ListABTestExperiments | Queries a list of experiments. |
| ListABTestScenes | ListABTestScenes | Queries test scenarios. |
| ListFirstRanks | ListFirstRanks | Queries the rough sort expressions that are configured for a version of an OpenSearch application. |
| RemoveUserAnalyzer | RemoveUserAnalyzer | Deletes a custom analyzer. |
| ReplaceAppGroupCommodityCode | ReplaceAppGroupCommodityCode | Converts a service-based application to an instance-based application. |
| SaveSortScriptFile | SaveSortScriptFile | Uploads a sort script. |