Build Custom Text Analyzers with OpenSearch CreateUserAnalyzer API - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:CreateUserAnalyzer

*Analyzer

acs:opensearch:{#regionId}:{#accountId}:user-analyzers/*

None

Request syntax

POST /v4/openapi/user-analyzers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
name	string	No	The name of the analyzer.	jmbon_analyzer
business	string	No	The name of the basic analyzer.	Chinese-General analyzer
businessType	string	No	The type of the basic analyzer. Valid values: AUTO, MODEL, SYSTEM, and USER.	AUTO
type	string	No	The engine type. Valid values: HA3 and ES.	HA3
businessAppGroupId	string	No	The application ID for the custom model-based analyzer.	110123123
dryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a check request without creating the analyzer. The system checks the AccessKey, RAM user authorization, and required parameters. false (default): sends a regular request to create the analyzer.	false

Response elements

Element	Type	Description	Example
	object
result	object	The returned result.	{}
RequestId	string	The request ID.	98724351-D6B2-5D8A-B089-7FFD1821A7E9

Examples

Success response

JSON format

{
  "result": {},
  "RequestId": "98724351-D6B2-5D8A-B089-7FFD1821A7E9"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.