ListQueryProcessors - OpenSearch - Alibaba Cloud Documentation Center

Queries a list of query analysis rules that are configured for a version of an OpenSearch application.

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:ListQueryProcessor		QueryProcessor acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name
appId	integer	Yes	The application version number.	110157886
isActive	integer	No	The scope of query analysis rules to be queried. Default value: 0. Valid values: 0: queries all query analysis rules. 1: queries the default query analysis rules. 2: queries the query analysis rules that are not the default rules.	0

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. For more information, see QueryProcessor .
created	integer	The time when the query analysis rule was created.	1587398402
active	boolean	Indicates whether the query analysis rule is a default rule.	true
updated	integer	The time when the query analysis rule was last modified.	1587398402
name	string	The name of the query analysis rule.	ner
domain	string	The type of the industry to which the query analysis rule is applied. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
indexes	array	The indexes to which the query analysis rule is applied.
	string	The indexes to which the query analysis rule is applied.	[ "default" ]
processors	object []	The features that are used in the query analysis rule.
	object	The feature that is used in the query analysis rule. For more information, see Processor .	[]

Examples

Sample success responses

JSONformat

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "created": 1587398402,
      "active": true,
      "updated": 1587398402,
      "name": "ner",
      "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

No change history