/
index.html
568 lines (348 loc) · 17.1 KB
/
index.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="utf-8">
<meta name="robots" content="all,follow">
<meta name="googlebot" content="index,follow,snippet,archive">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title></title>
<meta name="author" content="" />
<meta name="generator" content="Hugo 0.26" />
<link href='//fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,500,700,800' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link href="http://cassandra-reaper.io/css/animate.css" rel="stylesheet">
<link href="http://cassandra-reaper.io/css/style.default.css" rel="stylesheet" id="theme-stylesheet">
<link href="http://cassandra-reaper.io/css/custom.css" rel="stylesheet">
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="shortcut icon" href="http://cassandra-reaper.io/img/favicon.ico" type="image/x-icon" />
<link rel="apple-touch-icon" href="http://cassandra-reaper.io/img/apple-touch-icon.png" />
<link href="http://cassandra-reaper.io/css/owl.carousel.css" rel="stylesheet">
<link href="http://cassandra-reaper.io/css/owl.theme.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/fancybox/3.1.25/jquery.fancybox.min.css" />
<link rel="alternate" href="http://cassandra-reaper.io/index.xml" type="application/rss+xml" title="Reaper: Easy Repair Management for Apache Cassandra">
<meta property="og:title" content="" />
<meta property="og:type" content="website" />
<meta property="og:url" content="/docs/api//" />
<meta property="og:image" content="" />
</head>
<body>
<div id="all">
<header>
<div class="navbar-affixed-top" data-spy="affix" data-offset-top="200">
<div class="navbar navbar-default yamm" role="navigation" id="navbar">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand home" href="http://cassandra-reaper.io/">
<img src="http://cassandra-reaper.io/img/logo.png" alt=" logo" class="hidden-xs hidden-sm">
<img src="http://cassandra-reaper.io/img/logo-small.png" alt=" logo" class="visible-xs visible-sm">
<span class="sr-only"> - go to homepage</span>
</a>
<div class="navbar-buttons">
<button type="button" class="navbar-toggle btn-template-main" data-toggle="collapse" data-target="#navigation">
<span class="sr-only">Toggle Navigation</span>
<i class="fa fa-align-justify"></i>
</button>
</div>
</div>
<div class="navbar-collapse collapse" id="navigation">
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="/docs/">Documentation</a>
</li>
<li class="dropdown">
<a href="/docs/download/">Downloads</a>
</li>
<li class="dropdown">
<a href="/faq/">FAQ</a>
</li>
<li class="dropdown">
<a href="https://github.com/thelastpickle/cassandra-reaper">View on GitHub</a>
</li>
</ul>
</div>
<div class="collapse clearfix" id="search">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search">
<span class="input-group-btn">
<button type="submit" class="btn btn-template-main"><i class="fa fa-search"></i></button>
</span>
</div>
</form>
</div>
</div>
</div>
</div>
</header>
<div id="heading-breadcrumbs">
<div class="container">
<div class="row">
<div class="col-md-12">
<h1></h1>
</div>
</div>
</div>
</div>
<div id="content">
<div class="container">
<div class="row">
<div class="col-md-3">
<ul class="sidebar-menu">
<li class="sub-menu">
<a href="/docs/download/" class="">
<span>Downloads</span>
<span class="menu-arrow arrow_carrot-right"></span>
</a>
<ul class="sub">
<li><a href="/docs/download/install/"> Install and Run </a> </li>
<li><a href="/docs/download/building/"> Building from Source </a> </li>
<li><a href="/docs/download/docker/"> Docker </a> </li>
</ul>
</li>
<li class="sub-menu">
<a href="/docs/backends/" class="">
<span>Backends</span>
<span class="menu-arrow arrow_carrot-right"></span>
</a>
<ul class="sub">
<li><a href="/docs/backends/memory/"> In Memory </a> </li>
<li><a href="/docs/backends/h2/"> H2 </a> </li>
<li><a href="/docs/backends/postgres/"> Postgres </a> </li>
<li><a href="/docs/backends/cassandra/"> Cassandra </a> </li>
</ul>
</li>
<li class="sub-menu">
<a href="/docs/configuration/" class="">
<span>Configuration Reference</span>
<span class="menu-arrow arrow_carrot-right"></span>
</a>
<ul class="sub">
<li><a href="/docs/configuration/reaper_specific/"> Reaper Specific Settings </a> </li>
<li><a href="/docs/configuration/backend_specific/"> Backend Specific Settings </a> </li>
<li><a href="/docs/configuration/docker_vars/"> Docker Variables </a> </li>
</ul>
</li>
<li class="sub-menu">
<a href="/docs/usage/" class="">
<span>Usage</span>
<span class="menu-arrow arrow_carrot-right"></span>
</a>
<ul class="sub">
<li><a href="/docs/usage/add_cluster/"> Add a Cluster </a> </li>
<li><a href="/docs/usage/health/"> Check Cluster Health </a> </li>
<li><a href="/docs/usage/single/"> Running a Repair </a> </li>
<li><a href="/docs/usage/schedule/"> Scheduling Repairs </a> </li>
<li><a href="/docs/usage/multi_dc/"> Multi DC </a> </li>
<li><a href="/docs/usage/authentication/"> Activate authentication for the web UI </a> </li>
</ul>
</li>
<li>
<a href="/docs/api/">
<span>Rest API</span>
</a>
</li>
<li>
<a href="/docs/community/">
<span>Community</span>
</a>
</li>
</ul>
</div>
<div class="col-md-9">
<div>
<h1 id="rest-api">Rest API</h1>
<p>Source code for all the REST resources can be found from package io.cassandrareaper.resources.</p>
<h2 id="ping-resource">Ping Resource</h2>
<ul>
<li>GET /ping
<ul>
<li>Expected query parameters: <em>None</em></li>
<li>Simple ping resource that can be used to check whether the reaper is running.</li>
</ul></li>
</ul>
<h2 id="cluster-resource">Cluster Resource</h2>
<ul>
<li><p>GET /cluster</p>
<ul>
<li>Expected query parameters:
<ul>
<li><em>seedHost</em>: Limit the returned cluster list based on the given seed host. (Optional)</li>
</ul></li>
<li>Returns a list of registered cluster names in the service.</li>
</ul></li>
<li><p>GET /cluster/{cluster_name}</p>
<ul>
<li>Expected query parameters:</li>
<li><em>limit</em>: Limit the number of repair runs returned. Recent runs are prioritized. (Optional)</li>
<li>Returns a cluster object identified by the given “cluster_name” path parameter.</li>
</ul></li>
<li><p>POST /cluster</p>
<ul>
<li>Expected query parameters:
<ul>
<li><em>seedHost</em>: Host name or IP address of the added Cassandra
clusters seed host.</li>
</ul></li>
<li>Adds a new cluster to the service, and returns the newly added cluster object,
if the operation was successful.</li>
</ul></li>
<li><p>PUT /cluster/{cluster_name}</p>
<ul>
<li>Expected query parameters:
<ul>
<li><em>seedHost</em>: New host name or IP address used as Cassandra cluster seed.</li>
</ul></li>
<li>Modifies a cluster’s seed host. Comes in handy when the previous seed has left the cluster.</li>
</ul></li>
<li><p>DELETE /cluster/{cluster_name}</p>
<ul>
<li>Expected query parameters: <em>None</em></li>
<li>Delete a cluster object identified by the given “cluster_name” path parameter.
Cluster will get deleted only if there are no schedules or repair runs for the cluster,
or the request will fail. Delete repair runs and schedules first before calling this.</li>
</ul></li>
</ul>
<h2 id="repair-run-resource">Repair Run Resource</h2>
<ul>
<li><p>GET /repair_run</p>
<ul>
<li>Optional query parameters:</li>
<li><em>state</em>: Comma separated list of repair run state names. Only names found in
io.cassandrareaper.core.RunState are accepted.</li>
<li>Returns a list of repair runs, optionally fetching only the ones with <em>state</em> state.</li>
</ul></li>
<li><p>GET /repair_run/{id}</p>
<ul>
<li>Expected query parameters: <em>None</em></li>
<li>Returns a repair run object identified by the given “id” path parameter.</li>
</ul></li>
<li><p>GET /repair_run/cluster/{cluster_name} (io.cassandrareaper.resources.RepairRunResource)</p>
<ul>
<li>Expected query parameters: <em>None</em></li>
<li>Returns a list of all repair run statuses found for the given “cluster_name” path parameter.</li>
</ul></li>
<li><p>POST /repair_run</p>
<ul>
<li>Expected query parameters:</li>
<li><em>clusterName</em>: Name of the Cassandra cluster.</li>
<li><em>keyspace</em>: The name of the table keyspace.</li>
<li><em>tables</em>: The name of the targeted tables (column families) as comma separated list.
If no tables given, then the whole keyspace is targeted. (Optional)</li>
<li><em>owner</em>: Owner name for the run. This could be any string identifying the owner.</li>
<li><em>cause</em>: Identifies the process, or cause the repair was started. (Optional)</li>
<li><em>segmentCount</em>: Defines the amount of segments to create for repair run. (Optional)</li>
<li><em>repairParallelism</em>: Defines the used repair parallelism for repair run. (Optional)</li>
<li><em>intensity</em>: Defines the repair intensity for repair run. (Optional)</li>
<li><em>incrementalRepair</em>: Defines if incremental repair should be done. <a href="Optional">true/false</a></li>
</ul></li>
<li><p>PUT /repair_run/{id}</p>
<ul>
<li>Expected query parameters:</li>
<li><em>state</em>: New value for the state of the repair run.
Possible values for given state are: “PAUSED” or “RUNNING”.</li>
<li>Starts, pauses, or resumes a repair run identified by the “id” path parameter.</li>
<li>Can also be used to reattempt a repair run in state “ERROR”, picking up where it left off.</li>
</ul></li>
<li><p>DELETE /repair_run/{id}</p>
<ul>
<li>Expected query parameters:</li>
<li><em>owner</em>: Owner name for the run. If the given owner does not match the stored owner,
the delete request will fail.</li>
<li>Delete a repair run object identified by the given “id” path parameter.
Repair run and all the related repair segments will be deleted from the database.</li>
</ul></li>
</ul>
<h2 id="repair-schedule-resource">Repair Schedule Resource</h2>
<ul>
<li><p>GET /repair_schedule</p>
<ul>
<li>Expected query parameters:
<ul>
<li><em>clusterName</em>: Filter the returned schedule list based on the given
cluster name. (Optional)</li>
<li><em>keyspaceName</em>: Filter the returned schedule list based on the given
keyspace name. (Optional)</li>
</ul></li>
<li>Returns all repair schedules present in the Reaper</li>
</ul></li>
<li><p>GET /repair_schedule/{id}</p>
<ul>
<li>Expected query parameters: <em>None</em></li>
<li>Returns a repair schedule object identified by the given “id” path parameter.</li>
</ul></li>
<li><p>POST /repair_schedule</p>
<ul>
<li>Expected query parameters:</li>
<li><em>clusterName</em>: Name of the Cassandra cluster.</li>
<li><em>keyspace</em>: The name of the table keyspace.</li>
<li><em>tables</em>: The name of the targeted tables (column families) as comma separated list.
If no tables given, then the whole keyspace is targeted. (Optional)</li>
<li><em>owner</em>: Owner name for the schedule. This could be any string identifying the owner.</li>
<li><em>segmentCount</em>: Defines the amount of segments to create for scheduled repair runs. (Optional)</li>
<li><em>repairParallelism</em>: Defines the used repair parallelism for scheduled repair runs. (Optional)</li>
<li><em>intensity</em>: Defines the repair intensity for scheduled repair runs. (Optional)</li>
<li><em>incrementalRepair</em>: Defines if incremental repair should be done. <a href="Optional">true/false</a></li>
<li><em>scheduleDaysBetween</em>: Defines the amount of days to wait between scheduling new repairs.
For example, use value 7 for weekly schedule, and 0 for continuous.</li>
<li><em>scheduleTriggerTime</em>: Defines the time for first scheduled trigger for the run.
If you don’t give this value, it will be next mid-night (UTC).
Give date values in ISO format, e.g. “2015-02-11T01:00:00”. (Optional)</li>
</ul></li>
<li><p>DELETE /repair_schedule/{id}</p>
<ul>
<li>Expected query parameters:</li>
<li><em>owner</em>: Owner name for the schedule. If the given owner does not match the stored owner,
the delete request will fail.</li>
<li>Delete a repair schedule object identified by the given “id” path parameter.
Repair schedule will get deleted only if there are no associated repair runs for the schedule.
Delete all the related repair runs before calling this endpoint.</li>
</ul></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer id="footer">
<div class="container">
<div class="col-md-4 col-sm-6">
</div>
</div>
</footer>
<div id="copyright">
<div class="container">
<div class="col-md-12">
<p class="pull-right">
Template by <a href="http://bootstrapious.com/free-templates">Bootstrapious</a>.
Ported to Hugo by <a href="https://github.com/devcows/hugo-universal-theme">DevCows</a>
</p>
</div>
</div>
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-104925477-1', 'auto');
ga('send', 'pageview');
</script>
<script src="/js/jquery-3.2.1.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/waypoints/4.0.1/jquery.waypoints.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/Counter-Up/1.0/jquery.counterup.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery-parallax/1.1.3/jquery-parallax.js"></script>
<script src="//maps.googleapis.com/maps/api/js?v=3.exp"></script>
<script src="http://cassandra-reaper.io/js/hpneo.gmaps.js"></script>
<script src="http://cassandra-reaper.io/js/gmaps.init.js"></script>
<script src="http://cassandra-reaper.io/js/front.js"></script>
<script src="http://cassandra-reaper.io/js/owl.carousel.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fancybox/3.1.25/jquery.fancybox.min.js"></script>
</body>
</html>