ListQueryResult - OpenSearch - Alibaba Cloud Documentation Center

Queries the query result.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/query?query=xxxx

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
searchengine:ListQueryResult	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

GET /openapi/ha3/instances/{instanceId}/query HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-i7m2olkw201
query	string	No	The query statement	query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral
sql	string	No	The SQL statement that is executed in the query	query%3Dselect%20max(content_id)%20from%20generation

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request	9E5BCFAA-98B3-51D0-9188-B1BC07589337

Field	Type	Description
requestId	String	The ID of the request.
result	String	The string returned by the Havenask engine. It can be in a JSON or an xmsql format.

Examples

Sample success responses

JSONformat

{
  "requestId": "9E5BCFAA-98B3-51D0-9188-B1BC07589337"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details

Example

Sample requests

sql: GET /openapi/ha3/instances/ha3_instances_id/query?sql=query%3Dselect+%2A+from+mx_index1217

query: GET /openapi/ha3/instances/ha3_instances_id/query?query=config%3Dhit%3A4%2Cformat%3Ajson%2Cfetch_summary_type%3Apk%2Cqrs_chain%3Asearch%26%26query%3Did%3A8148508889615505646%26%26cluster%3Dgeneral

Sample responses

Success responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {}
}