OpenSearch:Initiate search requests

Endpoint

GET /v3/openapi/apps/{app_name}/search

{app_name}: the name of the application. Advanced and standard editions each have an online version and an offline version. Specify the ID of the target version. Typically, use the online application ID.

• Protocol: HTTP

• Format: JSON

• Signature: See Signature method of OpenSearch API V3

Request parameters

Response parameters

A successful search returns the following top-level structure:

{
  "status": "OK",
  "request_id": "162642700916781929257960",
  "result": {
    "searchtime": 0.009554,
    "total": 1,
    "viewtotal": 1,
    "num": 1,
    "compute_cost": [
      { "index_name": "110247758", "value": 0.304 }
    ],
    "items": [
      {
        "fields": { "pid": "950", "size": "XL", "discount_price": "9.9" },
        "sortExprValues": ["10000"],
        "variableValue": {},
        "property": {},
        "attribute": {}
      }
    ],
    "facet": []
  },
  "errors": []
}

Result fields:

Sample request and response

Sample request URL:

/v3/openapi/apps/my_app/search?fetch_fields=name&query=config=format:fulljson&&query=name:'zhangsan'&&sort=id

This URL omits the endpoint, request headers, and encoding details. For the complete signature and connection setup, see Signature method of OpenSearch API V3.

Sample success response (JSON format):

{
  "result": {
    "searchtime": 0.009554,
    "total": 1,
    "compute_cost": [{ "index_name": "110247758", "value": 0.304 }],
    "num": 1,
    "viewtotal": 1,
    "items": [
      {
        "variableValue": {},
        "sortExprValues": ["10000"],
        "property": {},
        "attribute": {},
        "fields": {
          "size": "XL",
          "discount_price": "9.9",
          "pid": "950",
          "range_age": "18\t25",
          "detail": "Male Jacket Lapel 2021 in Spring and Autumn New Style Youth Thin Casual Zip-up Jacket",
          "index_name": "110247758"
        }
      }
    ],
    "facet": []
  },
  "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642700916781929257960%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
  "tracer": "",
  "request_id": "162642700916781929257960",
  "errors": [],
  "status": "OK"
}

Sample error response:

{
  "result": {
    "searchtime": 0.003999,
    "total": 0,
    "compute_cost": [{ "index_name": "110247758", "value": 0.232 }],
    "num": 0,
    "viewtotal": 0,
    "items": [],
    "facet": []
  },
  "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642716516781913069826%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
  "tracer": "",
  "request_id": "162642716516781913069826",
  "errors": [{ "code": 6127, "message": "Attribute not exist." }],
  "status": "FAIL"
}

How it works

A scroll search runs in two phases:

1. First request: Send a request with search_type=scan and a scroll validity period. The response returns only a scroll_id — no documents.

2. Subsequent requests: Use the scroll_id from the previous response to retrieve the next batch of documents. When the response items array is empty, the scroll is complete and no more results are available.

Endpoints

First request:

GET /v3/openapi/apps/{app_name}/search?search_type=scan&scroll=1m&{query_parameters}

Subsequent requests:

GET /v3/openapi/apps/{app_name}/search?scroll_id={scroll_id}&scroll=1m&{query_parameters}

• Protocol: HTTP

• Format: fullJSON or JSON only (XML is not supported)

Request parameters

Response parameters

Same structure as the standard search response, with one additional field in result:

Limitations

Sample scroll search

The following requests omit request headers and encoding details.

First request:

http://{host}/v3/openapi/apps/app_schema_demo/search?query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'Search'&&sort=+id&&filter=id>0&search_type=scan&scroll=1m&fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id

Sample success response (first request):

{
  "status": "OK",
  "request_id": "150150574119953661605242",
  "result": {
    "searchtime": 0.005029,
    "total": 1,
    "num": 0,
    "viewtotal": 1,
    "scroll_id": "eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9VQVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1MMg3ROwCesLlG6X7a2o=",
    "items": [],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}

Subsequent request (using `scroll_id` from the previous response):

http://{host}/v3/openapi/apps/app_schema_demo/search?fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id&query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'Search'&&sort=+id&&filter=id>0&scroll=1m&scroll_id=eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V+QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1+MMg3ROwCesLlG6X7a2o=

Sample success response (subsequent request):

{
  "status": "OK",
  "request_id": "150150574119952551519970",
  "result": {
    "searchtime": 0.006293,
    "total": 1,
    "num": 1,
    "viewtotal": 1,
    "scroll_id": "eJxNT9tugzAM/RrznIRC4YEHaNlvRFFIhteQtE6Qtn39TNdJk2z5dnx8rIPJRdudcqKhl60Uir2Vp06ISv8b6s3QbZCVzpaCdp93XXBzg2wEW9MJ2dWq8q7YVXt0YckDLlBP0WyOw31N8YgYizZEnAUsjkx4VT4k8zexpjiNS/XYHX0NNkWP71BfVyxQjxLUxSfazFH4PYSPnCL3iMniDZq3jN98aFRCgGrZniy8/itkBHWGuYVeQH+B+QzTCUZ1NJ9gj4FVMfrQPr8Y+Hk+dgU14fIDVhtfTw==",
    "items": [
      {
        "fields": {
          "cate_id": "0",
          "float_arr": "0",
          "id": "1",
          "int_arr": "0",
          "literal_arr": "Search",
          "name": "Search",
          "phone": "123****5678",
          "index_name": "app_schema_demo"
        },
        "property": {},
        "attribute": {},
        "variableValue": {},
        "sortExprValues": ["1"]
      }
    ],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}