List of operations by function - OpenSearch

This product(OpenSearch/2017-12-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.

Application instance

API	Title	Description
Application Management	Application Management
RenewAppGroup	RenewAppGroup	Renews an application. This operation is not available now. You must renew an application in the OpenSearch console.
CreateAppGroup	CreateAppGroup	Creates an OpenSearch application.
ModifyAppGroup	ModifyAppGroup	Modifies the properties of an OpenSearch application or sets the online version of an OpenSearch application.
ModifyAppGroupQuota	ModifyAppGroupQuota	Modifies the quotas of an OpenSearch application.
RemoveAppGroup	RemoveAppGroup	Deletes an OpenSearch application.
ListAppGroups	ListAppGroups	Queries a list of OpenSearch applications.
Application Version	Application Version
CreateApp	CreateApp	Creates a version for an OpenSearch application.
RemoveApp	RemoveApp	Deletes a version of an OpenSearch application.
DescribeApps	DescribeApps
DescribeApp	DescribeApp
DescribeAppStatistics	DescribeAppStatistics	Queries the statistics about a version of an OpenSearch application.

Instance surrounding

API	Title	Description
Custom analyzer	Custom analyzer
ListUserAnalyzers	ListUserAnalyzers	Queries the custom analyzers that belong to the current account.
CreateUserAnalyzer	CreateUserAnalyzer
DescribeUserAnalyzer	DescribeUserAnalyzer
RemoveUserAnalyzer	RemoveUserAnalyzer	Deletes a custom analyzer.
ListUserAnalyzerEntries	ListUserAnalyzerEntries	Queries the entries of a custom analyzer.
PushUserAnalyzerEntries	PushUserAnalyzerEntries	Accepts the changes in the entries of a custom analyzer.
ABTest	ABTest
Experimental scene	Experimental scene
ListABTestScenes	ListABTestScenes	Queries test scenarios.
CreateABTestScene	CreateABTestScene	Creates an scenario.
DescribeABTestScene	DescribeABTestScene	Queries the information about an A/B test scenario.
UpdateABTestScene	UpdateABTestScene	Modifies an A/B test scenario.
DeleteABTestScene	DeleteABTestScene	Deletes an A/B test scenario.
The experimental group	The experimental group
ListABTestGroups	ListABTestGroups
CreateABTestGroup	CreateABTestGroup	Creates a test group.
DeleteABTestGroup	DeleteABTestGroup
DescribeABTestGroup	DescribeABTestGroup	Queries the details of a test group.
UpdateABTestGroup	UpdateABTestGroup	Modifies a test group.
Experiment	Experiment
ListABTestExperiments	ListABTestExperiments	Queries a list of experiments.
CreateABTestExperiment	CreateABTestExperiment	Creates an experiment.
DescribeABTestExperiment	DescribeABTestExperiment
UpdateABTestExperiment	UpdateABTestExperiment	Modifies the parameters of an A/B test.
DeleteABTestExperiment	DeleteABTestExperiment	Deletes a test.
Whitelist	Whitelist
ListABTestFixedFlowDividers	ListABTestFixedFlowDividers	Queries whitelists.
UpdateABTestFixedFlowDividers	UpdateABTestFixedFlowDividers	Modifies whitelists.
The crude row expression	The crude row expression
ListFirstRanks	ListFirstRanks	Queries the rough sort expressions that are configured for a version of an OpenSearch application.
CreateFirstRank	CreateFirstRank	Creates a rough sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified rough sort expression. By default, the value of dryRun is false if you do not set this parameter.
DescribeFirstRank	DescribeFirstRank	Queries a rough sort expression that is configured for an OpenSearch application version.
RemoveFirstRank	RemoveFirstRank	Deletes a rough sort expression for a version of an OpenSearch application.
ModifyFirstRank	ModifyFirstRank	Modifies a rough sort expression for an OpenSearch application. If you set dryRun to true, this operation checks the rough sort expression after the expression is modified. If you do not specify this parameter, false is used by default.
Fine row expression	Fine row expression
ListSecondRanks	ListSecondRanks	Queries the fine sort expressions that are configured for a version of an OpenSearch application.
CreateSecondRank	CreateSecondRank	Creates a fine sort expression for a version of an OpenSearch application. If you set dryRun to true, this operation checks the specified fine sort expression. The default value of dryRun is false if you do not set this parameter.
DescribeSecondRank	DescribeSecondRank	Queries a fine sort expression that is configured for a version of an OpenSearch application.
ModifySecondRank	ModifySecondRank	Modifies a fine sort expression that is configured for a specific OpenSearch application version. If you set dryRun to true, the specified fine sort expression is checked after the expression is modified. By default, the value of dryRun is false if you do not specify this parameter.
RemoveSecondRank	RemoveSecondRank	Deletes a fine sort expression from a version of an OpenSearch application.
Query analyzer	Query analyzer
ListQueryProcessors	ListQueryProcessors	Queries a list of query analysis rules that are configured for a version of an OpenSearch application.
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.
ModifyQueryProcessor	ModifyQueryProcessor	Modifies a query analysis rule for a specific application version. 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 specify this parameter.
RemoveQueryProcessor	RemoveQueryProcessor	Deletes a query analysis rule for an OpenSearch application version.
DescribeQueryProcessor	DescribeQueryProcessor	Queries the query analysis rule for a version of an OpenSearch application.
ListQueryProcessorNers	ListQueryProcessorNers	Queries the recommended priority settings of entity types for named entity recognition (NER).
ListQueryProcessorAnalyzerResults	ListQueryProcessorAnalyzerResults	Queries the results of a query analysis test. This API operation is available only to existing applications of OpenSearch Open Source Compatible Edition.
Intervention Dictionary	Intervention Dictionary
ListInterventionDictionaries	ListInterventionDictionaries
CreateInterventionDictionary	CreateInterventionDictionary	Create an intervention dictionary.
DescribeInterventionDictionary	DescribeInterventionDictionary	Queries the details of an intervention dictionary.
RemoveInterventionDictionary	RemoveInterventionDictionary	Deletes an intervention dictionary.
ListInterventionDictionaryEntries	ListInterventionDictionaryEntries	Queries the intervention entries in an intervention dictionary.
PushInterventionDictionaryEntries	PushInterventionDictionaryEntries	Accepts the changes in intervention entries.
ListInterventionDictionaryRelatedEntities	ListInterventionDictionaryRelatedEntities	Queries the resources that are associated with an intervention dictionary. If the intervention dictionary is referenced by query analysis rules, this operation returns all applications that use the intervention dictionary and the information about the query analysis rules.
ListInterventionDictionaryNerResults	ListInterventionDictionaryNerResults
The Master	The Master
EnableSlowQuery	EnableSlowQuery	Enables slow query optimization of Optimization Master.
DisableSlowQuery	DisableSlowQuery
DescribeSlowQueryStatus	DescribeSlowQueryStatus
StartSlowQueryAnalyzer	StartSlowQueryAnalyzer
ListSlowQueryQueries	ListSlowQueryQueries
ListSlowQueryCategories	ListSlowQueryCategories	Queries the suggestions that are provided by Optimization Master for slow queries.
Quota approval	Quota approval
ListQuotaReviewTasks	ListQuotaReviewTasks	Queries tickets that are submitted to apply for quotas for an OpenSearch application.
Scheduled Tasks	Scheduled Tasks
ListScheduledTasks	ListScheduledTasks	Queries a list of scheduled tasks of an OpenSearch application.
CreateScheduledTask	CreateScheduledTask	Creates a scheduled task for an OpenSearch application.
DescribeScheduledTask	DescribeScheduledTask
ModifyScheduledTask	ModifyScheduledTask	Modifies a scheduled task.
RemoveScheduledTask	RemoveScheduledTask	Deletes a scheduled task of an OpenSearch application.
Search Strategy	Search Strategy
ListSortExpressions	ListSortExpressions	Queries a list of sort expressions that are configured for a version of an OpenSearch application.
ElasticSearch Engine instance	ElasticSearch Engine instance
UnbindEsInstance	UnbindEsInstance	Unbinds an Elasticsearch instance from an OpenSearch application.
BindEsInstance	BindEsInstance	Binds an Elasticsearch instance.
BindESUserAnalyzer	BindESUserAnalyzer	Binds a custom analyzer to an Elasticsearch instance.
UnbindESUserAnalyzer	UnbindESUserAnalyzer	Unbinds a custom analyzer from an Elasticsearch instance.
The current process flow	The current process flow
ListProceedings	ListProceedings
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 reports, drop-down suggestion reports, hotword shading reports, A/B test reports, and data quality reports.
cava script	cava script
UpdateSortScript	UpdateSortScript	Modifies the description of a sort script.
SaveSortScriptFile	SaveSortScriptFile	Uploads a sort script.
ReleaseSortScript	ReleaseSortScript
GetSortScriptFile	GetSortScriptFile	Queries the content of a sort script.
GetSortScript	GetSortScript	Queries the details of a sort script.
GetScriptFileNames	GetScriptFileNames
DeleteSortScriptFile	DeleteSortScriptFile	Deletes a script file.
DeleteSortScript	DeleteSortScript
CreateSortScript	CreateSortScript	Creates a sort script.
CompileSortScript	CompileSortScript	Compiles a sort script.
Query the throttling policies	Query the throttling policies
UpdateSearchStrategy	UpdateSearchStrategy	Modifies a query policy.
RemoveSearchStrategy	RemoveSearchStrategy	Deletes a query policy.
ListSearchStrategies	ListSearchStrategies	Queries the details of query policies.
GetSearchStrategy	GetSearchStrategy	Queries the details of a query policy.
CreateSearchStrategy	CreateSearchStrategy	Creates a query policy.

Version surrounding

API	Title	Description
By default fields	By default fields
UpdateFetchFields	UpdateFetchFields	Updates fetch fields. A dry run is supported.
A summary of search results and	A summary of search results and
UpdateSummaries	UpdateSummaries	Updates summaries. A dry run is supported.

Algorithm surrounding

API	Title	Description
CreateFunctionResource	CreateFunctionResource	Creates an algorithm resource for a specific feature.
GetFunctionCurrentVersion	GetFunctionCurrentVersion	Queries the version information about the current feature when you create an instance.
GetFunctionVersion	GetFunctionVersion	Queries version information by version ID.
GetFunctionDefaultInstance	GetFunctionDefaultInstance	Queries the algorithm instance that an application uses by default.
UpdateFunctionDefaultInstance	UpdateFunctionDefaultInstance	Sets the default algorithm instance used by the specified application. The new algorithm instance automatically overwrites the most recently set default instance. If no instance is set, the default instance is canceled.
ListFunctionTasks	ListFunctionTasks	Queries the training tasks. The returned results are sorted by start time in descending order.
GetFunctionTask	GetFunctionTask	Queries the details of a training task.
DeleteFunctionTask	DeleteFunctionTask	Deletes a training task. The training task in progress cannot be deleted.
CreateFunctionTask	CreateFunctionTask	Starts a training task for an algorithm instance.
ListFunctionInstances	ListFunctionInstances	Queries all algorithm instances of a user, which meet specified conditions.
GetFunctionInstance	GetFunctionInstance	Queries the details of an algorithm instance by instance name.
DeleteFunctionInstance	DeleteFunctionInstance	Deletes an algorithm instance. Before you delete an instance, make sure that it is not in use to prevent service interruptions.
UpdateFunctionInstance	UpdateFunctionInstance	Updates an algorithm instance.
CreateFunctionInstance	CreateFunctionInstance	Creates an algorithm instance of a feature.

Others

API	Title	Description
DescribeAppGroup	DescribeAppGroup	Queries the details of an OpenSearch application.
ValidateDataSources	ValidateDataSources	Verifies data sources.
ReplaceAppGroupCommodityCode	ReplaceAppGroupCommodityCode	Converts a service-based application to an instance-based application.
ListSortScripts	ListSortScripts	Queries all sort scripts of an application version.
ListDataSourceTables	ListDataSourceTables	Obtains all data from a specified data source.
ListDataSourceTableFields	ListDataSourceTableFields	Queries all fields in a table of a data source. This operation is for internal use only.
GetDomain	GetDomain	Queries the type of an industry.
GenerateMergedTable	GenerateMergedTable	Queries the information about a wide table that is generated after a JOIN operation is performed on multiple tables.
DescribeRegions	DescribeRegions	Queries the endpoints of all regions that support OpenSearch.

other

API	Title	Description
DescribeDataCollction	DescribeDataCollction	Queries the details of a data collection task of an application.
ListDataCollections	ListDataCollections	Queries the data collection tasks of an OpenSearch application.
RemoveDataCollection	RemoveDataCollection	Disables data collection.
UntagResources	UntagResources	Remove tags from resources.
ListTagResources	ListTagResources	Queries tagged resources.
TagResources	TagResources	Adds tags to resources.
GetFunctionResource	GetFunctionResource	Queries an algorithm resource.
ListFunctionResources	ListFunctionResources	Queries algorithm resources.
DeleteFunctionResource	DeleteFunctionResource	Deletes an algorithm resource.
UpdateFunctionResource	UpdateFunctionResource	Updates an algorithm resource.