ModifyQueryProcessor - OpenSearch - Alibaba Cloud Documentation Center

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

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	"my_app_group_name"	“my_app_group_name”
appId	integer	Yes	110157886	110157886
dryRun	boolean	No	true	true
name	string	Yes	"test"	“test”
body	any	No

Request body

Field	Type	Required	Example	Description
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.
processors[]	Object	No		The analysis rule.
active	Boolean	No	true	Specifies whether the query analysis rule is enabled.

Reference: QueryProcessor

Response parameters

Parameter	Type	Description	Example
	object	The response body.
requestId	string	The ID of the request.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The information about the query analysis rule.
created	integer	The time when the rule was created.	0
active	boolean	Indicates whether the query analysis rule is the default one.	true
updated	integer	The most recent update time.	1
name	string	The name of the query analysis rule.	synonym
domain	string	The type of the industry. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
indexes	array	The indexes to which the query analysis rule applies.
	string	The indexes to which the query analysis rule applies.	[ "default" ]
processors	object []	The analysis rule.	[]
	object	The response body.	[ "default" ]

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 0,
    "active": true,
    "updated": 1,
    "name": "synonym",
    "domain": "GENERAL",
    "indexes": [
      "[ \"default\" ]"
    ],
    "processors": [
      [
        "default"
      ]
    ]
  }
}

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