-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--ariel-searches-POST.html
352 lines (256 loc) · 8.91 KB
/
12.0--ariel-searches-POST.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<!DOCTYPE html><html lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<meta name="dcterms.rights" content="© Copyright IBM Corporation 2022">
<meta name="description" content="Create a new asynchronous Ariel search.">
<meta name="keywords" content="/ariel/searches, POST, API, REST API">
<meta name="geo.country" content="ZZ">
<script>
digitalData = {
page: {
pageInfo: {
language: "en-us",
version: "v18",
ibm: {
country: "ZZ",
type: "CT701"
}
}
}
};
</script><!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="ibmdita.css">
<link rel="Start" href="c_rest_api_version120_ariel_intro.html">
<title>POST /ariel/searches</title>
</head>
<body id="api-12.0--ariel-searches-POST"><main role="main"><article role="article" aria-labelledby="d175161e10">
<h1 class="topictitle1" id="d175161e10">POST /ariel/searches</h1>
<div class="body refbody"><p class="shortdesc">Create a new asynchronous Ariel search.</p>
<div class="section refsyn">
<p>Creates a new Ariel search as specified by the Ariel Query Language (AQL)
query expression. Searches are executed asynchronously. A
reference to the search ID is returned and should be used in subsequent API calls to determine
the status of the search and retrieve the results once it is complete.</p>
<p>This endpoint only accepts SELECT query expressions.</p>
<p>Queries are applied to the range of data in a certain time interval. By default this time interval is the last 60 seconds. An alternative time interval can be specified
by specifying them as part of the query expression. For further information, see the AQL reference guide.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/searches resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /ariel/searches resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d175161e70" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d175161e70 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/searches request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /ariel/searches request parameter details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d175161e118" class="thbot">Parameter</th>
<th id="d175161e121" class="thbot">Type</th>
<th id="d175161e124" class="thbot">Optionality</th>
<th id="d175161e127" class="thbot">Data Type</th>
<th id="d175161e130" class="thbot">MIME Type</th>
<th id="d175161e134" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d175161e118 "><p>query_expression</p>
</td>
<td headers="d175161e121 "><p>query</p>
</td>
<td headers="d175161e124 "><p>Optional</p>
</td>
<td headers="d175161e127 "><p>String</p>
</td>
<td headers="d175161e130 "><p>text/plain</p>
</td>
<td headers="d175161e134 "><p>Optional - The AQL query to execute. Mutually exclusive with saved_search_id</p>
</td>
</tr>
<tr>
<td headers="d175161e118 "><p>saved_search_id</p>
</td>
<td headers="d175161e121 "><p>query</p>
</td>
<td headers="d175161e124 "><p>Optional</p>
</td>
<td headers="d175161e127 "><p>Number (Integer)</p>
</td>
<td headers="d175161e130 "><p>text/plain</p>
</td>
<td headers="d175161e134 "><p>Optional - Saved search ID to execute. Mutually exclusive with queryExpression</p>
</td>
</tr>
<tr>
<td headers="d175161e118 "><p>data_lake</p>
</td>
<td headers="d175161e121 "><p>query</p>
</td>
<td headers="d175161e124 "><p>Optional</p>
</td>
<td headers="d175161e127 "><p>String</p>
</td>
<td headers="d175161e130 "><p>text/plain</p>
</td>
<td headers="d175161e134 "><p>Optional - If the search should be executed for QCDL then "qcdl" should be entered in this field. Only "qcdl" can be entered in this field</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/searches response codes" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /ariel/searches response codes</span></caption><colgroup><col style="width:20%"><col style="width:20%"><col style="width:60%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d175161e252" class="thbot">HTTP Response Code</th>
<th id="d175161e255" class="thbot">Unique Code</th>
<th id="d175161e258" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d175161e252 "><p>201</p>
</td>
<td headers="d175161e255 "><p></p>
</td>
<td headers="d175161e258 "><p>A new Ariel search was successfully created.</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>404</p>
</td>
<td headers="d175161e255 "><p>1002</p>
</td>
<td headers="d175161e258 "><p>The Ariel saved search does not exist.</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>409</p>
</td>
<td headers="d175161e255 "><p>1004</p>
</td>
<td headers="d175161e258 "><p>The search cannot be created. The requested search ID that was provided in the query expression is already in use. Please use a unique search ID (or allow one to be generated).</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>422</p>
</td>
<td headers="d175161e255 "><p>2000</p>
</td>
<td headers="d175161e258 "><p>The query_expression contains invalid AQL syntax.</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>422</p>
</td>
<td headers="d175161e255 "><p>1005</p>
</td>
<td headers="d175161e258 "><p>A request parameter is not valid.</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>500</p>
</td>
<td headers="d175161e255 "><p>1020</p>
</td>
<td headers="d175161e258 "><p>An error occurred during the attempt to create a new search.</p>
</td>
</tr>
<tr>
<td headers="d175161e252 "><p>503</p>
</td>
<td headers="d175161e255 "><p>1010</p>
</td>
<td headers="d175161e258 "><p>The Ariel server might be temporarily unavailable or offline. Please try again later.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d175161e376"><h2 class="sectiontitle" id="d175161e376">Response Description</h2>
<p>Information about the specified search, including the search ID. Use the search ID to access or manipulate the search with the other API endpoints.</p>
<p>If the exact search being created was already recently created, the response message will return a reference to the original search ID rather than creating a new search.</p>
</section>
<section class="section refsyn" role="region" aria-labelledby="d175161e389"><h2 class="sectiontitle" id="d175161e389">Response Sample</h2>
<pre class="codeblock"><code>
{
"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"
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d175161e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_ariel_intro.html" title="Use the references for REST API 12.0 Ariel endpoints.">Ariel endpoints</a></div>
</div>
</nav></aside></article></main></body></html>