GET /ariel/searches/{search_id}

date_range 04-Aug-21

arrow_backward

arrow_forward

SUMMARY Retrieves information about an Ariel search.

Retrieve status information for a search, based on the search ID parameter. The same informational fields are returned regardless of whether the search is in progress or is complete.

Table 1: GET /ariel/searches/{search_id} resource details:
GET /ariel/searches/{search_id} resource details
MIME Type
application/json

Table 2: GET /ariel/searches/{search_id} request parameter details:
GET /ariel/searches/{search_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
search_id	path	Required	String	text/plain	Required. The identifier for an Ariel search.
Prefer	header	Optional	String	text/plain	Optional. Specify 'wait=N' where N is number of seconds to wait for COMPLETED status of the search.

Table 3: GET /ariel/searches/{search_id} response codes:
GET /ariel/searches/{search_id} response codes
HTTP Response Code	Unique Code	Description
200		The search information was retrieved.
206		The search information was retrieved with 'Prefer: wait=N' timeout(sec) expired before the search is completed
404	1002	The search does not exist.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to retrieve the search information.
503	1010	The Ariel server might be temporarily unavailable or offline. Please try again later.

Response Description

Information about the specified search, including the search status.

Response Sample

content_copy zoom_out_map
{
  "cursor_id": "s16",
  "compressed_data_file_count": 0,
  "compressed_data_total_size": 0,
  "data_file_count": 5470,
  "data_total_size": 67183115,
  "index_file_count": 0,
  "index_total_size": 0,
  "processed_record_count": 1256462,
  "error_messages": [
    {
      "code": "String",
      "contexts": [
        "String"
      ],
      "message": "String",
      "severity": "String <one of: INFO, WARN, ERROR>"
    }
  ],
  "desired_retention_time_msec": 86400000,
  "progress": 46,
  "progress_details": [
    0,
    0,
    0,
    0,
    66957,
    652657,
    76594,
    89809,
    86032,
    107729
  ],
  "query_execution_time": 1480,
  "query_string": "SELECT sourceip, starttime, qid, sourceport  from events into s16 where sourceip in (select destinationip from events) parameters snapshotsize=2, PROGRESSDETAILSRESOLUTION=10",
  "record_count": 1240923,
  "save_results": false,
  "status": "String <one of: WAIT, EXECUTE, SORTING, COMPLETED, CANCELED, ERROR>",
  "snapshot": {
    "events": [
      {
        "sourceip": "10.100.65.20",
        "starttime": 1467049610018,
        "qid": 10034,
        "sourceport": 13675
      },
      {
        "sourceip": "10.100.100.121",
        "starttime": 1467049610019,
        "qid": 20034,
        "sourceport": 80
      }
    ]
  },
  "subsearch_ids": [
     "sub_id_1"
   ],
  "search_id": "s16"
}

arrow_backward PREVIOUS DELETE /ariel/searches/{search_id}

NEXT arrow_forward POST /ariel/searches/{search_id}

REST API Version 16.0 References

ON THIS PAGE

GET /ariel/searches/{search_id}

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry