CreateQueryProcessor - OpenSearch - Alibaba Cloud Documentation Center

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:WriteQueryProcessor		QueryProcessor acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
appId	integer	Yes	The version number of the application.	110157886
dryRun	boolean	No	Specifies whether to perform a dry run.	true
body	any	No	The request body.	{}

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"test"	The name of the query analysis rule.
processors[]	Object	Yes	N/A	The query analysis rule.For more information, see QueryProcessor .
domain	String	No	"GENERAL"	The type of the industry to which the query analysis rule applies. Valid values:GENERAL: general.ECOMMERCE: e-commerce.IT_CONTENT: IT content.
indexes	Array	No	["default"]	The indexes to which the query analysis rule applies.
active	Boolean	No	true	Specifies whether to enable the query analysis rule.

For more information, see QueryProcessor .

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	The information about the query analysis rule.
created	integer	The time when the query analysis rule was created.	1587398402
active	boolean	Indicates whether the query analysis rule is the default one.	true
updated	integer	The time when the query analysis rule was last modified.	1587398402
name	string	The name of the query analysis rule.	query_filter
domain	string	The type of the industry to which the query analysis rule was applied. Valid values: GENERAL: general. ECOMMERCE: e-commerce. IT_CONTENT: IT content.	GENERAL
indexes	array	The indexes to which the query analysis rule was applied.
	string	The indexes to which the query analysis rule was applied.	"default"
processors	object []	The features that are used in the query analysis rule. For more information, see QueryProcessor .
	object	The features that are used in the query analysis rule.	{}

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-05-24

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: body