All Products
Search
Document Center

OpenSearch:ListQueryResult

Last Updated:Jul 16, 2024

Queries the query result.

Operation description

Method

GET

URI

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

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-i7m2olkw201
querystringNo

The query statement

query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral
sqlstringNo

The SQL statement that is executed in the query

query%3Dselect%20max(content_id)%20from%20generation

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The ID of the request

9E5BCFAA-98B3-51D0-9188-B1BC07589337
FieldTypeDescription
requestIdStringThe ID of the request.
resultStringThe 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 timeSummary of changesOperation
2022-01-12Add OperationView 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": {}
}