Create OpenSearch Query Analysis Rules with CreateQueryProcessor API - OpenSearch - Alibaba Cloud - 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:WriteQueryProcessor

create

*QueryProcessor

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/query-processors HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name
appId	integer	Yes	The version number.	110157886

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether this is a dry run request.	true
body	any	No	The request body.	{}

Request body

Field	Type	Required	Example	Description
name	String	Yes	"test"	The rule name.
processors[]	Object	Yes	--	The analysis rule. For more information, see Processor.
domain	String	No	"GENERAL"	The industry type. Valid values: - GENERAL: general-purpose - ECOMMERCE: E-commerce - IT_CONTENT: IT content
indexes	Array	No	["default"]	The index scope of the application.
active	Boolean	No	true	Specifies whether to set the rule as active.

For more information, see QueryProcessor.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	The rule information.
created	integer	The creation time.	1587398402
active	boolean	Indicates whether this is the default rule.	true
updated	integer	The update time.	1587398402
name	string	The rule name.	query_filter
domain	string	The industry type. Valid values: GENERAL: general-purpose ECOMMERCE: E-commerce IT_CONTENT: IT content	GENERAL
indexes	array	The index scope of the application.
	string	The index scope of the application.	"default"
processors	array<object>	The included features. For more information, see Processor.
	object	The included features.	{}
category	string

Examples

Success response

JSON format

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1587398402,
    "active": true,
    "updated": 1587398402,
    "name": "query_filter",
    "domain": "GENERAL",
    "indexes": [
      "\"default\""
    ],
    "processors": [
      {}
    ],
    "category": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.