]>
Commit | Line | Data |
---|---|---|
f67539c2 TL |
1 | basePath: / |
2 | components: | |
3 | securitySchemes: | |
4 | jwt: | |
5 | bearerFormat: JWT | |
6 | scheme: bearer | |
7 | type: http | |
8 | host: example.com | |
9 | info: | |
10 | description: This is the official Ceph REST API | |
11 | title: Ceph REST API | |
12 | version: v1 | |
13 | openapi: 3.0.0 | |
14 | paths: | |
15 | /api/auth: | |
16 | post: | |
17 | parameters: [] | |
18 | requestBody: | |
19 | content: | |
20 | application/json: | |
21 | schema: | |
22 | properties: | |
23 | password: | |
24 | type: string | |
25 | username: | |
26 | type: string | |
27 | required: | |
28 | - username | |
29 | - password | |
30 | type: object | |
31 | responses: | |
32 | '201': | |
33 | content: | |
34 | application/vnd.ceph.api.v1.0+json: | |
35 | type: object | |
36 | description: Resource created. | |
37 | '202': | |
38 | content: | |
39 | application/vnd.ceph.api.v1.0+json: | |
40 | type: object | |
41 | description: Operation is still executing. Please check the task queue. | |
42 | '400': | |
43 | description: Operation exception. Please check the response body for details. | |
44 | '401': | |
45 | description: Unauthenticated access. Please login first. | |
46 | '403': | |
47 | description: Unauthorized access. Please check your permissions. | |
48 | '500': | |
49 | description: Unexpected error. Please check the response body for the stack | |
50 | trace. | |
51 | tags: | |
52 | - Auth | |
53 | /api/auth/check: | |
54 | post: | |
55 | parameters: | |
56 | - description: Authentication Token | |
57 | in: query | |
58 | name: token | |
59 | required: true | |
60 | schema: | |
61 | type: string | |
62 | requestBody: | |
63 | content: | |
64 | application/json: | |
65 | schema: | |
66 | properties: | |
67 | token: | |
68 | description: Authentication Token | |
69 | type: string | |
70 | required: | |
71 | - token | |
72 | type: object | |
73 | responses: | |
74 | '201': | |
75 | content: | |
76 | application/vnd.ceph.api.v1.0+json: | |
77 | schema: | |
78 | properties: | |
79 | permissions: | |
80 | description: List of permissions acquired | |
81 | properties: | |
82 | cephfs: | |
83 | description: '' | |
84 | items: | |
85 | type: string | |
86 | type: array | |
87 | required: | |
88 | - cephfs | |
89 | type: object | |
90 | pwdUpdateRequired: | |
91 | description: Is password update required? | |
92 | type: boolean | |
93 | sso: | |
94 | description: Uses single sign on? | |
95 | type: boolean | |
96 | username: | |
97 | description: Username | |
98 | type: string | |
99 | required: | |
100 | - username | |
101 | - permissions | |
102 | - sso | |
103 | - pwdUpdateRequired | |
104 | type: object | |
105 | description: Resource created. | |
106 | '202': | |
107 | content: | |
108 | application/vnd.ceph.api.v1.0+json: | |
109 | type: object | |
110 | description: Operation is still executing. Please check the task queue. | |
111 | '400': | |
112 | description: Operation exception. Please check the response body for details. | |
113 | '401': | |
114 | description: Unauthenticated access. Please login first. | |
115 | '403': | |
116 | description: Unauthorized access. Please check your permissions. | |
117 | '500': | |
118 | description: Unexpected error. Please check the response body for the stack | |
119 | trace. | |
120 | summary: Check token Authentication | |
121 | tags: | |
122 | - Auth | |
123 | /api/auth/logout: | |
124 | post: | |
125 | parameters: [] | |
126 | responses: | |
127 | '201': | |
128 | content: | |
129 | application/vnd.ceph.api.v1.0+json: | |
130 | type: object | |
131 | description: Resource created. | |
132 | '202': | |
133 | content: | |
134 | application/vnd.ceph.api.v1.0+json: | |
135 | type: object | |
136 | description: Operation is still executing. Please check the task queue. | |
137 | '400': | |
138 | description: Operation exception. Please check the response body for details. | |
139 | '401': | |
140 | description: Unauthenticated access. Please login first. | |
141 | '403': | |
142 | description: Unauthorized access. Please check your permissions. | |
143 | '500': | |
144 | description: Unexpected error. Please check the response body for the stack | |
145 | trace. | |
146 | tags: | |
147 | - Auth | |
148 | /api/block/image: | |
149 | get: | |
150 | parameters: | |
151 | - allowEmptyValue: true | |
152 | description: Pool Name | |
153 | in: query | |
154 | name: pool_name | |
155 | schema: | |
156 | type: string | |
2a845540 TL |
157 | - default: 0 |
158 | description: offset | |
159 | in: query | |
160 | name: offset | |
161 | schema: | |
162 | type: integer | |
163 | - default: 5 | |
164 | description: limit | |
165 | in: query | |
166 | name: limit | |
167 | schema: | |
168 | type: integer | |
169 | - default: '' | |
170 | in: query | |
171 | name: search | |
172 | schema: | |
173 | type: string | |
174 | - default: '' | |
175 | in: query | |
176 | name: sort | |
177 | schema: | |
178 | type: string | |
f67539c2 TL |
179 | responses: |
180 | '200': | |
181 | content: | |
2a845540 | 182 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
183 | schema: |
184 | items: | |
185 | properties: | |
186 | pool_name: | |
187 | description: pool name | |
188 | type: string | |
f67539c2 TL |
189 | value: |
190 | description: '' | |
191 | items: | |
192 | type: string | |
193 | type: array | |
194 | type: object | |
195 | required: | |
f67539c2 TL |
196 | - value |
197 | - pool_name | |
198 | type: array | |
199 | description: OK | |
200 | '400': | |
201 | description: Operation exception. Please check the response body for details. | |
202 | '401': | |
203 | description: Unauthenticated access. Please login first. | |
204 | '403': | |
205 | description: Unauthorized access. Please check your permissions. | |
206 | '500': | |
207 | description: Unexpected error. Please check the response body for the stack | |
208 | trace. | |
209 | security: | |
210 | - jwt: [] | |
211 | summary: Display Rbd Images | |
212 | tags: | |
213 | - Rbd | |
214 | post: | |
215 | parameters: [] | |
216 | requestBody: | |
217 | content: | |
218 | application/json: | |
219 | schema: | |
220 | properties: | |
221 | configuration: | |
222 | type: string | |
223 | data_pool: | |
224 | type: string | |
225 | features: | |
226 | type: string | |
2a845540 TL |
227 | mirror_mode: |
228 | type: string | |
f67539c2 TL |
229 | name: |
230 | type: string | |
231 | namespace: | |
232 | type: string | |
233 | obj_size: | |
234 | type: integer | |
235 | pool_name: | |
236 | type: string | |
2a845540 TL |
237 | schedule_interval: |
238 | default: '' | |
239 | type: string | |
f67539c2 TL |
240 | size: |
241 | type: integer | |
242 | stripe_count: | |
243 | type: integer | |
244 | stripe_unit: | |
245 | type: string | |
246 | required: | |
247 | - name | |
248 | - pool_name | |
249 | - size | |
250 | type: object | |
251 | responses: | |
252 | '201': | |
253 | content: | |
254 | application/vnd.ceph.api.v1.0+json: | |
255 | type: object | |
256 | description: Resource created. | |
257 | '202': | |
258 | content: | |
259 | application/vnd.ceph.api.v1.0+json: | |
260 | type: object | |
261 | description: Operation is still executing. Please check the task queue. | |
262 | '400': | |
263 | description: Operation exception. Please check the response body for details. | |
264 | '401': | |
265 | description: Unauthenticated access. Please login first. | |
266 | '403': | |
267 | description: Unauthorized access. Please check your permissions. | |
268 | '500': | |
269 | description: Unexpected error. Please check the response body for the stack | |
270 | trace. | |
271 | security: | |
272 | - jwt: [] | |
273 | tags: | |
274 | - Rbd | |
275 | /api/block/image/clone_format_version: | |
276 | get: | |
277 | description: "Return the RBD clone format version.\n " | |
278 | parameters: [] | |
279 | responses: | |
280 | '200': | |
281 | content: | |
282 | application/vnd.ceph.api.v1.0+json: | |
283 | type: object | |
284 | description: OK | |
285 | '400': | |
286 | description: Operation exception. Please check the response body for details. | |
287 | '401': | |
288 | description: Unauthenticated access. Please login first. | |
289 | '403': | |
290 | description: Unauthorized access. Please check your permissions. | |
291 | '500': | |
292 | description: Unexpected error. Please check the response body for the stack | |
293 | trace. | |
294 | security: | |
295 | - jwt: [] | |
296 | tags: | |
297 | - Rbd | |
298 | /api/block/image/default_features: | |
299 | get: | |
300 | parameters: [] | |
301 | responses: | |
302 | '200': | |
303 | content: | |
304 | application/vnd.ceph.api.v1.0+json: | |
305 | type: object | |
306 | description: OK | |
307 | '400': | |
308 | description: Operation exception. Please check the response body for details. | |
309 | '401': | |
310 | description: Unauthenticated access. Please login first. | |
311 | '403': | |
312 | description: Unauthorized access. Please check your permissions. | |
313 | '500': | |
314 | description: Unexpected error. Please check the response body for the stack | |
315 | trace. | |
316 | security: | |
317 | - jwt: [] | |
318 | tags: | |
319 | - Rbd | |
320 | /api/block/image/trash: | |
321 | get: | |
322 | description: List all entries from trash. | |
323 | parameters: | |
324 | - allowEmptyValue: true | |
325 | description: Name of the pool | |
326 | in: query | |
327 | name: pool_name | |
328 | schema: | |
329 | type: string | |
330 | responses: | |
331 | '200': | |
332 | content: | |
333 | application/vnd.ceph.api.v1.0+json: | |
334 | schema: | |
335 | items: | |
336 | properties: | |
337 | pool_name: | |
338 | description: pool name | |
339 | type: string | |
340 | status: | |
341 | description: '' | |
342 | type: integer | |
343 | value: | |
344 | description: '' | |
345 | items: | |
346 | type: string | |
347 | type: array | |
348 | type: object | |
349 | required: | |
350 | - status | |
351 | - value | |
352 | - pool_name | |
353 | type: array | |
354 | description: OK | |
355 | '400': | |
356 | description: Operation exception. Please check the response body for details. | |
357 | '401': | |
358 | description: Unauthenticated access. Please login first. | |
359 | '403': | |
360 | description: Unauthorized access. Please check your permissions. | |
361 | '500': | |
362 | description: Unexpected error. Please check the response body for the stack | |
363 | trace. | |
364 | security: | |
365 | - jwt: [] | |
366 | summary: Get RBD Trash Details by pool name | |
367 | tags: | |
368 | - RbdTrash | |
369 | /api/block/image/trash/purge: | |
370 | post: | |
371 | description: Remove all expired images from trash. | |
372 | parameters: | |
373 | - allowEmptyValue: true | |
374 | in: query | |
375 | name: pool_name | |
376 | schema: | |
377 | type: string | |
378 | requestBody: | |
379 | content: | |
380 | application/json: | |
381 | schema: | |
382 | properties: | |
383 | pool_name: | |
384 | type: string | |
385 | type: object | |
386 | responses: | |
387 | '201': | |
388 | content: | |
389 | application/vnd.ceph.api.v1.0+json: | |
390 | type: object | |
391 | description: Resource created. | |
392 | '202': | |
393 | content: | |
394 | application/vnd.ceph.api.v1.0+json: | |
395 | type: object | |
396 | description: Operation is still executing. Please check the task queue. | |
397 | '400': | |
398 | description: Operation exception. Please check the response body for details. | |
399 | '401': | |
400 | description: Unauthenticated access. Please login first. | |
401 | '403': | |
402 | description: Unauthorized access. Please check your permissions. | |
403 | '500': | |
404 | description: Unexpected error. Please check the response body for the stack | |
405 | trace. | |
406 | security: | |
407 | - jwt: [] | |
408 | tags: | |
409 | - RbdTrash | |
410 | /api/block/image/trash/{image_id_spec}: | |
411 | delete: | |
412 | description: "Delete an image from trash.\n If image deferment time has\ | |
413 | \ not expired you can not removed it unless use force.\n But an actively\ | |
414 | \ in-use by clones or has snapshots can not be removed.\n " | |
415 | parameters: | |
416 | - in: path | |
417 | name: image_id_spec | |
418 | required: true | |
419 | schema: | |
420 | type: string | |
421 | - default: false | |
422 | in: query | |
423 | name: force | |
424 | schema: | |
425 | type: boolean | |
426 | responses: | |
427 | '202': | |
428 | content: | |
429 | application/vnd.ceph.api.v1.0+json: | |
430 | type: object | |
431 | description: Operation is still executing. Please check the task queue. | |
432 | '204': | |
433 | content: | |
434 | application/vnd.ceph.api.v1.0+json: | |
435 | type: object | |
436 | description: Resource deleted. | |
437 | '400': | |
438 | description: Operation exception. Please check the response body for details. | |
439 | '401': | |
440 | description: Unauthenticated access. Please login first. | |
441 | '403': | |
442 | description: Unauthorized access. Please check your permissions. | |
443 | '500': | |
444 | description: Unexpected error. Please check the response body for the stack | |
445 | trace. | |
446 | security: | |
447 | - jwt: [] | |
448 | tags: | |
449 | - RbdTrash | |
450 | /api/block/image/trash/{image_id_spec}/restore: | |
451 | post: | |
452 | description: Restore an image from trash. | |
453 | parameters: | |
454 | - in: path | |
455 | name: image_id_spec | |
456 | required: true | |
457 | schema: | |
458 | type: string | |
459 | requestBody: | |
460 | content: | |
461 | application/json: | |
462 | schema: | |
463 | properties: | |
464 | new_image_name: | |
465 | type: string | |
466 | required: | |
467 | - new_image_name | |
468 | type: object | |
469 | responses: | |
470 | '201': | |
471 | content: | |
472 | application/vnd.ceph.api.v1.0+json: | |
473 | type: object | |
474 | description: Resource created. | |
475 | '202': | |
476 | content: | |
477 | application/vnd.ceph.api.v1.0+json: | |
478 | type: object | |
479 | description: Operation is still executing. Please check the task queue. | |
480 | '400': | |
481 | description: Operation exception. Please check the response body for details. | |
482 | '401': | |
483 | description: Unauthenticated access. Please login first. | |
484 | '403': | |
485 | description: Unauthorized access. Please check your permissions. | |
486 | '500': | |
487 | description: Unexpected error. Please check the response body for the stack | |
488 | trace. | |
489 | security: | |
490 | - jwt: [] | |
491 | tags: | |
492 | - RbdTrash | |
493 | /api/block/image/{image_spec}: | |
494 | delete: | |
495 | parameters: | |
496 | - in: path | |
497 | name: image_spec | |
498 | required: true | |
499 | schema: | |
500 | type: string | |
501 | responses: | |
502 | '202': | |
503 | content: | |
504 | application/vnd.ceph.api.v1.0+json: | |
505 | type: object | |
506 | description: Operation is still executing. Please check the task queue. | |
507 | '204': | |
508 | content: | |
509 | application/vnd.ceph.api.v1.0+json: | |
510 | type: object | |
511 | description: Resource deleted. | |
512 | '400': | |
513 | description: Operation exception. Please check the response body for details. | |
514 | '401': | |
515 | description: Unauthenticated access. Please login first. | |
516 | '403': | |
517 | description: Unauthorized access. Please check your permissions. | |
518 | '500': | |
519 | description: Unexpected error. Please check the response body for the stack | |
520 | trace. | |
521 | security: | |
522 | - jwt: [] | |
523 | tags: | |
524 | - Rbd | |
525 | get: | |
526 | parameters: | |
527 | - in: path | |
528 | name: image_spec | |
529 | required: true | |
530 | schema: | |
531 | type: string | |
532 | responses: | |
533 | '200': | |
534 | content: | |
535 | application/vnd.ceph.api.v1.0+json: | |
536 | type: object | |
537 | description: OK | |
538 | '400': | |
539 | description: Operation exception. Please check the response body for details. | |
540 | '401': | |
541 | description: Unauthenticated access. Please login first. | |
542 | '403': | |
543 | description: Unauthorized access. Please check your permissions. | |
544 | '500': | |
545 | description: Unexpected error. Please check the response body for the stack | |
546 | trace. | |
547 | security: | |
548 | - jwt: [] | |
549 | tags: | |
550 | - Rbd | |
551 | put: | |
552 | parameters: | |
553 | - in: path | |
554 | name: image_spec | |
555 | required: true | |
556 | schema: | |
557 | type: string | |
558 | requestBody: | |
559 | content: | |
560 | application/json: | |
561 | schema: | |
562 | properties: | |
563 | configuration: | |
564 | type: string | |
2a845540 TL |
565 | enable_mirror: |
566 | type: string | |
f67539c2 TL |
567 | features: |
568 | type: string | |
2a845540 TL |
569 | mirror_mode: |
570 | type: string | |
f67539c2 TL |
571 | name: |
572 | type: string | |
2a845540 TL |
573 | primary: |
574 | type: string | |
575 | remove_scheduling: | |
576 | default: false | |
577 | type: boolean | |
578 | resync: | |
579 | default: false | |
580 | type: boolean | |
581 | schedule_interval: | |
582 | default: '' | |
583 | type: string | |
f67539c2 TL |
584 | size: |
585 | type: integer | |
586 | type: object | |
587 | responses: | |
588 | '200': | |
589 | content: | |
590 | application/vnd.ceph.api.v1.0+json: | |
591 | type: object | |
592 | description: Resource updated. | |
593 | '202': | |
594 | content: | |
595 | application/vnd.ceph.api.v1.0+json: | |
596 | type: object | |
597 | description: Operation is still executing. Please check the task queue. | |
598 | '400': | |
599 | description: Operation exception. Please check the response body for details. | |
600 | '401': | |
601 | description: Unauthenticated access. Please login first. | |
602 | '403': | |
603 | description: Unauthorized access. Please check your permissions. | |
604 | '500': | |
605 | description: Unexpected error. Please check the response body for the stack | |
606 | trace. | |
607 | security: | |
608 | - jwt: [] | |
609 | tags: | |
610 | - Rbd | |
611 | /api/block/image/{image_spec}/copy: | |
612 | post: | |
613 | parameters: | |
614 | - in: path | |
615 | name: image_spec | |
616 | required: true | |
617 | schema: | |
618 | type: string | |
619 | requestBody: | |
620 | content: | |
621 | application/json: | |
622 | schema: | |
623 | properties: | |
624 | configuration: | |
625 | type: string | |
626 | data_pool: | |
627 | type: string | |
628 | dest_image_name: | |
629 | type: string | |
630 | dest_namespace: | |
631 | type: string | |
632 | dest_pool_name: | |
633 | type: string | |
634 | features: | |
635 | type: string | |
636 | obj_size: | |
637 | type: integer | |
638 | snapshot_name: | |
639 | type: string | |
640 | stripe_count: | |
641 | type: integer | |
642 | stripe_unit: | |
643 | type: string | |
644 | required: | |
645 | - dest_pool_name | |
646 | - dest_namespace | |
647 | - dest_image_name | |
648 | type: object | |
649 | responses: | |
650 | '201': | |
651 | content: | |
652 | application/vnd.ceph.api.v1.0+json: | |
653 | type: object | |
654 | description: Resource created. | |
655 | '202': | |
656 | content: | |
657 | application/vnd.ceph.api.v1.0+json: | |
658 | type: object | |
659 | description: Operation is still executing. Please check the task queue. | |
660 | '400': | |
661 | description: Operation exception. Please check the response body for details. | |
662 | '401': | |
663 | description: Unauthenticated access. Please login first. | |
664 | '403': | |
665 | description: Unauthorized access. Please check your permissions. | |
666 | '500': | |
667 | description: Unexpected error. Please check the response body for the stack | |
668 | trace. | |
669 | security: | |
670 | - jwt: [] | |
671 | tags: | |
672 | - Rbd | |
673 | /api/block/image/{image_spec}/flatten: | |
674 | post: | |
675 | parameters: | |
676 | - in: path | |
677 | name: image_spec | |
678 | required: true | |
679 | schema: | |
680 | type: string | |
681 | responses: | |
682 | '201': | |
683 | content: | |
684 | application/vnd.ceph.api.v1.0+json: | |
685 | type: object | |
686 | description: Resource created. | |
687 | '202': | |
688 | content: | |
689 | application/vnd.ceph.api.v1.0+json: | |
690 | type: object | |
691 | description: Operation is still executing. Please check the task queue. | |
692 | '400': | |
693 | description: Operation exception. Please check the response body for details. | |
694 | '401': | |
695 | description: Unauthenticated access. Please login first. | |
696 | '403': | |
697 | description: Unauthorized access. Please check your permissions. | |
698 | '500': | |
699 | description: Unexpected error. Please check the response body for the stack | |
700 | trace. | |
701 | security: | |
702 | - jwt: [] | |
703 | tags: | |
704 | - Rbd | |
705 | /api/block/image/{image_spec}/move_trash: | |
706 | post: | |
707 | description: "Move an image to the trash.\n Images, even ones actively\ | |
708 | \ in-use by clones,\n can be moved to the trash and deleted at a later\ | |
709 | \ time.\n " | |
710 | parameters: | |
711 | - in: path | |
712 | name: image_spec | |
713 | required: true | |
714 | schema: | |
715 | type: string | |
716 | requestBody: | |
717 | content: | |
718 | application/json: | |
719 | schema: | |
720 | properties: | |
721 | delay: | |
722 | default: 0 | |
723 | type: integer | |
724 | type: object | |
725 | responses: | |
726 | '201': | |
727 | content: | |
728 | application/vnd.ceph.api.v1.0+json: | |
729 | type: object | |
730 | description: Resource created. | |
731 | '202': | |
732 | content: | |
733 | application/vnd.ceph.api.v1.0+json: | |
734 | type: object | |
735 | description: Operation is still executing. Please check the task queue. | |
736 | '400': | |
737 | description: Operation exception. Please check the response body for details. | |
738 | '401': | |
739 | description: Unauthenticated access. Please login first. | |
740 | '403': | |
741 | description: Unauthorized access. Please check your permissions. | |
742 | '500': | |
743 | description: Unexpected error. Please check the response body for the stack | |
744 | trace. | |
745 | security: | |
746 | - jwt: [] | |
747 | tags: | |
748 | - Rbd | |
749 | /api/block/image/{image_spec}/snap: | |
750 | post: | |
751 | parameters: | |
752 | - in: path | |
753 | name: image_spec | |
754 | required: true | |
755 | schema: | |
756 | type: string | |
757 | requestBody: | |
758 | content: | |
759 | application/json: | |
760 | schema: | |
761 | properties: | |
762 | snapshot_name: | |
763 | type: string | |
764 | required: | |
765 | - snapshot_name | |
766 | type: object | |
767 | responses: | |
768 | '201': | |
769 | content: | |
770 | application/vnd.ceph.api.v1.0+json: | |
771 | type: object | |
772 | description: Resource created. | |
773 | '202': | |
774 | content: | |
775 | application/vnd.ceph.api.v1.0+json: | |
776 | type: object | |
777 | description: Operation is still executing. Please check the task queue. | |
778 | '400': | |
779 | description: Operation exception. Please check the response body for details. | |
780 | '401': | |
781 | description: Unauthenticated access. Please login first. | |
782 | '403': | |
783 | description: Unauthorized access. Please check your permissions. | |
784 | '500': | |
785 | description: Unexpected error. Please check the response body for the stack | |
786 | trace. | |
787 | security: | |
788 | - jwt: [] | |
789 | tags: | |
790 | - RbdSnapshot | |
791 | /api/block/image/{image_spec}/snap/{snapshot_name}: | |
792 | delete: | |
793 | parameters: | |
794 | - in: path | |
795 | name: image_spec | |
796 | required: true | |
797 | schema: | |
798 | type: string | |
799 | - in: path | |
800 | name: snapshot_name | |
801 | required: true | |
802 | schema: | |
803 | type: string | |
804 | responses: | |
805 | '202': | |
806 | content: | |
807 | application/vnd.ceph.api.v1.0+json: | |
808 | type: object | |
809 | description: Operation is still executing. Please check the task queue. | |
810 | '204': | |
811 | content: | |
812 | application/vnd.ceph.api.v1.0+json: | |
813 | type: object | |
814 | description: Resource deleted. | |
815 | '400': | |
816 | description: Operation exception. Please check the response body for details. | |
817 | '401': | |
818 | description: Unauthenticated access. Please login first. | |
819 | '403': | |
820 | description: Unauthorized access. Please check your permissions. | |
821 | '500': | |
822 | description: Unexpected error. Please check the response body for the stack | |
823 | trace. | |
824 | security: | |
825 | - jwt: [] | |
826 | tags: | |
827 | - RbdSnapshot | |
828 | put: | |
829 | parameters: | |
830 | - in: path | |
831 | name: image_spec | |
832 | required: true | |
833 | schema: | |
834 | type: string | |
835 | - in: path | |
836 | name: snapshot_name | |
837 | required: true | |
838 | schema: | |
839 | type: string | |
840 | requestBody: | |
841 | content: | |
842 | application/json: | |
843 | schema: | |
844 | properties: | |
845 | is_protected: | |
846 | type: boolean | |
847 | new_snap_name: | |
848 | type: string | |
849 | type: object | |
850 | responses: | |
851 | '200': | |
852 | content: | |
853 | application/vnd.ceph.api.v1.0+json: | |
854 | type: object | |
855 | description: Resource updated. | |
856 | '202': | |
857 | content: | |
858 | application/vnd.ceph.api.v1.0+json: | |
859 | type: object | |
860 | description: Operation is still executing. Please check the task queue. | |
861 | '400': | |
862 | description: Operation exception. Please check the response body for details. | |
863 | '401': | |
864 | description: Unauthenticated access. Please login first. | |
865 | '403': | |
866 | description: Unauthorized access. Please check your permissions. | |
867 | '500': | |
868 | description: Unexpected error. Please check the response body for the stack | |
869 | trace. | |
870 | security: | |
871 | - jwt: [] | |
872 | tags: | |
873 | - RbdSnapshot | |
874 | /api/block/image/{image_spec}/snap/{snapshot_name}/clone: | |
875 | post: | |
876 | description: "\n Clones a snapshot to an image\n " | |
877 | parameters: | |
878 | - in: path | |
879 | name: image_spec | |
880 | required: true | |
881 | schema: | |
882 | type: string | |
883 | - in: path | |
884 | name: snapshot_name | |
885 | required: true | |
886 | schema: | |
887 | type: string | |
888 | requestBody: | |
889 | content: | |
890 | application/json: | |
891 | schema: | |
892 | properties: | |
893 | child_image_name: | |
894 | type: string | |
895 | child_namespace: | |
896 | type: string | |
897 | child_pool_name: | |
898 | type: string | |
899 | configuration: | |
900 | type: string | |
901 | data_pool: | |
902 | type: string | |
903 | features: | |
904 | type: string | |
905 | obj_size: | |
906 | type: integer | |
907 | stripe_count: | |
908 | type: integer | |
909 | stripe_unit: | |
910 | type: string | |
911 | required: | |
912 | - child_pool_name | |
913 | - child_image_name | |
914 | type: object | |
915 | responses: | |
916 | '201': | |
917 | content: | |
918 | application/vnd.ceph.api.v1.0+json: | |
919 | type: object | |
920 | description: Resource created. | |
921 | '202': | |
922 | content: | |
923 | application/vnd.ceph.api.v1.0+json: | |
924 | type: object | |
925 | description: Operation is still executing. Please check the task queue. | |
926 | '400': | |
927 | description: Operation exception. Please check the response body for details. | |
928 | '401': | |
929 | description: Unauthenticated access. Please login first. | |
930 | '403': | |
931 | description: Unauthorized access. Please check your permissions. | |
932 | '500': | |
933 | description: Unexpected error. Please check the response body for the stack | |
934 | trace. | |
935 | security: | |
936 | - jwt: [] | |
937 | tags: | |
938 | - RbdSnapshot | |
939 | /api/block/image/{image_spec}/snap/{snapshot_name}/rollback: | |
940 | post: | |
941 | parameters: | |
942 | - in: path | |
943 | name: image_spec | |
944 | required: true | |
945 | schema: | |
946 | type: string | |
947 | - in: path | |
948 | name: snapshot_name | |
949 | required: true | |
950 | schema: | |
951 | type: string | |
952 | responses: | |
953 | '201': | |
954 | content: | |
955 | application/vnd.ceph.api.v1.0+json: | |
956 | type: object | |
957 | description: Resource created. | |
958 | '202': | |
959 | content: | |
960 | application/vnd.ceph.api.v1.0+json: | |
961 | type: object | |
962 | description: Operation is still executing. Please check the task queue. | |
963 | '400': | |
964 | description: Operation exception. Please check the response body for details. | |
965 | '401': | |
966 | description: Unauthenticated access. Please login first. | |
967 | '403': | |
968 | description: Unauthorized access. Please check your permissions. | |
969 | '500': | |
970 | description: Unexpected error. Please check the response body for the stack | |
971 | trace. | |
972 | security: | |
973 | - jwt: [] | |
974 | tags: | |
975 | - RbdSnapshot | |
976 | /api/block/mirroring/pool/{pool_name}: | |
977 | get: | |
978 | parameters: | |
979 | - description: Pool Name | |
980 | in: path | |
981 | name: pool_name | |
982 | required: true | |
983 | schema: | |
984 | type: string | |
985 | responses: | |
986 | '200': | |
987 | content: | |
988 | application/vnd.ceph.api.v1.0+json: | |
989 | schema: | |
990 | properties: | |
991 | mirror_mode: | |
992 | description: Mirror Mode | |
993 | type: string | |
994 | required: | |
995 | - mirror_mode | |
996 | type: object | |
997 | description: OK | |
998 | '400': | |
999 | description: Operation exception. Please check the response body for details. | |
1000 | '401': | |
1001 | description: Unauthenticated access. Please login first. | |
1002 | '403': | |
1003 | description: Unauthorized access. Please check your permissions. | |
1004 | '500': | |
1005 | description: Unexpected error. Please check the response body for the stack | |
1006 | trace. | |
1007 | security: | |
1008 | - jwt: [] | |
1009 | summary: Display Rbd Mirroring Summary | |
1010 | tags: | |
1011 | - RbdMirroringPoolMode | |
1012 | put: | |
1013 | parameters: | |
1014 | - in: path | |
1015 | name: pool_name | |
1016 | required: true | |
1017 | schema: | |
1018 | type: string | |
1019 | requestBody: | |
1020 | content: | |
1021 | application/json: | |
1022 | schema: | |
1023 | properties: | |
1024 | mirror_mode: | |
1025 | type: string | |
1026 | type: object | |
1027 | responses: | |
1028 | '200': | |
1029 | content: | |
1030 | application/vnd.ceph.api.v1.0+json: | |
1031 | type: object | |
1032 | description: Resource updated. | |
1033 | '202': | |
1034 | content: | |
1035 | application/vnd.ceph.api.v1.0+json: | |
1036 | type: object | |
1037 | description: Operation is still executing. Please check the task queue. | |
1038 | '400': | |
1039 | description: Operation exception. Please check the response body for details. | |
1040 | '401': | |
1041 | description: Unauthenticated access. Please login first. | |
1042 | '403': | |
1043 | description: Unauthorized access. Please check your permissions. | |
1044 | '500': | |
1045 | description: Unexpected error. Please check the response body for the stack | |
1046 | trace. | |
1047 | security: | |
1048 | - jwt: [] | |
1049 | tags: | |
1050 | - RbdMirroringPoolMode | |
1051 | /api/block/mirroring/pool/{pool_name}/bootstrap/peer: | |
1052 | post: | |
1053 | parameters: | |
1054 | - in: path | |
1055 | name: pool_name | |
1056 | required: true | |
1057 | schema: | |
1058 | type: string | |
1059 | requestBody: | |
1060 | content: | |
1061 | application/json: | |
1062 | schema: | |
1063 | properties: | |
1064 | direction: | |
1065 | type: string | |
1066 | token: | |
1067 | type: string | |
1068 | required: | |
1069 | - direction | |
1070 | - token | |
1071 | type: object | |
1072 | responses: | |
1073 | '201': | |
1074 | content: | |
1075 | application/vnd.ceph.api.v1.0+json: | |
1076 | type: object | |
1077 | description: Resource created. | |
1078 | '202': | |
1079 | content: | |
1080 | application/vnd.ceph.api.v1.0+json: | |
1081 | type: object | |
1082 | description: Operation is still executing. Please check the task queue. | |
1083 | '400': | |
1084 | description: Operation exception. Please check the response body for details. | |
1085 | '401': | |
1086 | description: Unauthenticated access. Please login first. | |
1087 | '403': | |
1088 | description: Unauthorized access. Please check your permissions. | |
1089 | '500': | |
1090 | description: Unexpected error. Please check the response body for the stack | |
1091 | trace. | |
1092 | security: | |
1093 | - jwt: [] | |
1094 | tags: | |
1095 | - RbdMirroringPoolBootstrap | |
1096 | /api/block/mirroring/pool/{pool_name}/bootstrap/token: | |
1097 | post: | |
1098 | parameters: | |
1099 | - in: path | |
1100 | name: pool_name | |
1101 | required: true | |
1102 | schema: | |
1103 | type: string | |
1104 | responses: | |
1105 | '201': | |
1106 | content: | |
1107 | application/vnd.ceph.api.v1.0+json: | |
1108 | type: object | |
1109 | description: Resource created. | |
1110 | '202': | |
1111 | content: | |
1112 | application/vnd.ceph.api.v1.0+json: | |
1113 | type: object | |
1114 | description: Operation is still executing. Please check the task queue. | |
1115 | '400': | |
1116 | description: Operation exception. Please check the response body for details. | |
1117 | '401': | |
1118 | description: Unauthenticated access. Please login first. | |
1119 | '403': | |
1120 | description: Unauthorized access. Please check your permissions. | |
1121 | '500': | |
1122 | description: Unexpected error. Please check the response body for the stack | |
1123 | trace. | |
1124 | security: | |
1125 | - jwt: [] | |
1126 | tags: | |
1127 | - RbdMirroringPoolBootstrap | |
1128 | /api/block/mirroring/pool/{pool_name}/peer: | |
1129 | get: | |
1130 | parameters: | |
1131 | - in: path | |
1132 | name: pool_name | |
1133 | required: true | |
1134 | schema: | |
1135 | type: string | |
1136 | responses: | |
1137 | '200': | |
1138 | content: | |
1139 | application/vnd.ceph.api.v1.0+json: | |
1140 | type: object | |
1141 | description: OK | |
1142 | '400': | |
1143 | description: Operation exception. Please check the response body for details. | |
1144 | '401': | |
1145 | description: Unauthenticated access. Please login first. | |
1146 | '403': | |
1147 | description: Unauthorized access. Please check your permissions. | |
1148 | '500': | |
1149 | description: Unexpected error. Please check the response body for the stack | |
1150 | trace. | |
1151 | security: | |
1152 | - jwt: [] | |
1153 | tags: | |
1154 | - RbdMirroringPoolPeer | |
1155 | post: | |
1156 | parameters: | |
1157 | - in: path | |
1158 | name: pool_name | |
1159 | required: true | |
1160 | schema: | |
1161 | type: string | |
1162 | requestBody: | |
1163 | content: | |
1164 | application/json: | |
1165 | schema: | |
1166 | properties: | |
1167 | client_id: | |
1168 | type: string | |
1169 | cluster_name: | |
1170 | type: string | |
1171 | key: | |
1172 | type: string | |
1173 | mon_host: | |
1174 | type: string | |
1175 | required: | |
1176 | - cluster_name | |
1177 | - client_id | |
1178 | type: object | |
1179 | responses: | |
1180 | '201': | |
1181 | content: | |
1182 | application/vnd.ceph.api.v1.0+json: | |
1183 | type: object | |
1184 | description: Resource created. | |
1185 | '202': | |
1186 | content: | |
1187 | application/vnd.ceph.api.v1.0+json: | |
1188 | type: object | |
1189 | description: Operation is still executing. Please check the task queue. | |
1190 | '400': | |
1191 | description: Operation exception. Please check the response body for details. | |
1192 | '401': | |
1193 | description: Unauthenticated access. Please login first. | |
1194 | '403': | |
1195 | description: Unauthorized access. Please check your permissions. | |
1196 | '500': | |
1197 | description: Unexpected error. Please check the response body for the stack | |
1198 | trace. | |
1199 | security: | |
1200 | - jwt: [] | |
1201 | tags: | |
1202 | - RbdMirroringPoolPeer | |
1203 | /api/block/mirroring/pool/{pool_name}/peer/{peer_uuid}: | |
1204 | delete: | |
1205 | parameters: | |
1206 | - in: path | |
1207 | name: pool_name | |
1208 | required: true | |
1209 | schema: | |
1210 | type: string | |
1211 | - in: path | |
1212 | name: peer_uuid | |
1213 | required: true | |
1214 | schema: | |
1215 | type: string | |
1216 | responses: | |
1217 | '202': | |
1218 | content: | |
1219 | application/vnd.ceph.api.v1.0+json: | |
1220 | type: object | |
1221 | description: Operation is still executing. Please check the task queue. | |
1222 | '204': | |
1223 | content: | |
1224 | application/vnd.ceph.api.v1.0+json: | |
1225 | type: object | |
1226 | description: Resource deleted. | |
1227 | '400': | |
1228 | description: Operation exception. Please check the response body for details. | |
1229 | '401': | |
1230 | description: Unauthenticated access. Please login first. | |
1231 | '403': | |
1232 | description: Unauthorized access. Please check your permissions. | |
1233 | '500': | |
1234 | description: Unexpected error. Please check the response body for the stack | |
1235 | trace. | |
1236 | security: | |
1237 | - jwt: [] | |
1238 | tags: | |
1239 | - RbdMirroringPoolPeer | |
1240 | get: | |
1241 | parameters: | |
1242 | - in: path | |
1243 | name: pool_name | |
1244 | required: true | |
1245 | schema: | |
1246 | type: string | |
1247 | - in: path | |
1248 | name: peer_uuid | |
1249 | required: true | |
1250 | schema: | |
1251 | type: string | |
1252 | responses: | |
1253 | '200': | |
1254 | content: | |
1255 | application/vnd.ceph.api.v1.0+json: | |
1256 | type: object | |
1257 | description: OK | |
1258 | '400': | |
1259 | description: Operation exception. Please check the response body for details. | |
1260 | '401': | |
1261 | description: Unauthenticated access. Please login first. | |
1262 | '403': | |
1263 | description: Unauthorized access. Please check your permissions. | |
1264 | '500': | |
1265 | description: Unexpected error. Please check the response body for the stack | |
1266 | trace. | |
1267 | security: | |
1268 | - jwt: [] | |
1269 | tags: | |
1270 | - RbdMirroringPoolPeer | |
1271 | put: | |
1272 | parameters: | |
1273 | - in: path | |
1274 | name: pool_name | |
1275 | required: true | |
1276 | schema: | |
1277 | type: string | |
1278 | - in: path | |
1279 | name: peer_uuid | |
1280 | required: true | |
1281 | schema: | |
1282 | type: string | |
1283 | requestBody: | |
1284 | content: | |
1285 | application/json: | |
1286 | schema: | |
1287 | properties: | |
1288 | client_id: | |
1289 | type: string | |
1290 | cluster_name: | |
1291 | type: string | |
1292 | key: | |
1293 | type: string | |
1294 | mon_host: | |
1295 | type: string | |
1296 | type: object | |
1297 | responses: | |
1298 | '200': | |
1299 | content: | |
1300 | application/vnd.ceph.api.v1.0+json: | |
1301 | type: object | |
1302 | description: Resource updated. | |
1303 | '202': | |
1304 | content: | |
1305 | application/vnd.ceph.api.v1.0+json: | |
1306 | type: object | |
1307 | description: Operation is still executing. Please check the task queue. | |
1308 | '400': | |
1309 | description: Operation exception. Please check the response body for details. | |
1310 | '401': | |
1311 | description: Unauthenticated access. Please login first. | |
1312 | '403': | |
1313 | description: Unauthorized access. Please check your permissions. | |
1314 | '500': | |
1315 | description: Unexpected error. Please check the response body for the stack | |
1316 | trace. | |
1317 | security: | |
1318 | - jwt: [] | |
1319 | tags: | |
1320 | - RbdMirroringPoolPeer | |
1321 | /api/block/mirroring/site_name: | |
1322 | get: | |
1323 | parameters: [] | |
1324 | responses: | |
1325 | '200': | |
1326 | content: | |
1327 | application/vnd.ceph.api.v1.0+json: | |
1328 | schema: | |
1329 | properties: | |
1330 | site_name: | |
1331 | description: Site Name | |
1332 | type: string | |
1333 | required: | |
1334 | - site_name | |
1335 | type: object | |
1336 | description: OK | |
1337 | '400': | |
1338 | description: Operation exception. Please check the response body for details. | |
1339 | '401': | |
1340 | description: Unauthenticated access. Please login first. | |
1341 | '403': | |
1342 | description: Unauthorized access. Please check your permissions. | |
1343 | '500': | |
1344 | description: Unexpected error. Please check the response body for the stack | |
1345 | trace. | |
1346 | security: | |
1347 | - jwt: [] | |
1348 | summary: Display Rbd Mirroring sitename | |
1349 | tags: | |
1350 | - RbdMirroring | |
1351 | put: | |
1352 | parameters: [] | |
1353 | requestBody: | |
1354 | content: | |
1355 | application/json: | |
1356 | schema: | |
1357 | properties: | |
1358 | site_name: | |
1359 | type: string | |
1360 | required: | |
1361 | - site_name | |
1362 | type: object | |
1363 | responses: | |
1364 | '200': | |
1365 | content: | |
1366 | application/vnd.ceph.api.v1.0+json: | |
1367 | type: object | |
1368 | description: Resource updated. | |
1369 | '202': | |
1370 | content: | |
1371 | application/vnd.ceph.api.v1.0+json: | |
1372 | type: object | |
1373 | description: Operation is still executing. Please check the task queue. | |
1374 | '400': | |
1375 | description: Operation exception. Please check the response body for details. | |
1376 | '401': | |
1377 | description: Unauthenticated access. Please login first. | |
1378 | '403': | |
1379 | description: Unauthorized access. Please check your permissions. | |
1380 | '500': | |
1381 | description: Unexpected error. Please check the response body for the stack | |
1382 | trace. | |
1383 | security: | |
1384 | - jwt: [] | |
1385 | tags: | |
1386 | - RbdMirroring | |
1387 | /api/block/mirroring/summary: | |
1388 | get: | |
1389 | parameters: [] | |
1390 | responses: | |
1391 | '200': | |
1392 | content: | |
1393 | application/vnd.ceph.api.v1.0+json: | |
1394 | schema: | |
1395 | properties: | |
1396 | content_data: | |
1397 | description: '' | |
1398 | properties: | |
1399 | daemons: | |
1400 | description: '' | |
1401 | items: | |
1402 | type: string | |
1403 | type: array | |
1404 | image_error: | |
1405 | description: '' | |
1406 | items: | |
1407 | type: string | |
1408 | type: array | |
1409 | image_ready: | |
1410 | description: '' | |
1411 | items: | |
1412 | type: string | |
1413 | type: array | |
1414 | image_syncing: | |
1415 | description: '' | |
1416 | items: | |
1417 | type: string | |
1418 | type: array | |
1419 | pools: | |
1420 | description: Pools | |
1421 | items: | |
1422 | properties: | |
1423 | health: | |
1424 | description: pool health | |
1425 | type: string | |
1426 | health_color: | |
1427 | description: '' | |
1428 | type: string | |
1429 | mirror_mode: | |
1430 | description: status | |
1431 | type: string | |
1432 | name: | |
1433 | description: Pool name | |
1434 | type: string | |
1435 | peer_uuids: | |
1436 | description: '' | |
1437 | items: | |
1438 | type: string | |
1439 | type: array | |
1440 | required: | |
1441 | - name | |
1442 | - health_color | |
1443 | - health | |
1444 | - mirror_mode | |
1445 | - peer_uuids | |
1446 | type: object | |
1447 | type: array | |
1448 | required: | |
1449 | - daemons | |
1450 | - pools | |
1451 | - image_error | |
1452 | - image_syncing | |
1453 | - image_ready | |
1454 | type: object | |
1455 | site_name: | |
1456 | description: site name | |
1457 | type: string | |
1458 | status: | |
1459 | description: '' | |
1460 | type: integer | |
1461 | required: | |
1462 | - site_name | |
1463 | - status | |
1464 | - content_data | |
1465 | type: object | |
1466 | description: OK | |
1467 | '400': | |
1468 | description: Operation exception. Please check the response body for details. | |
1469 | '401': | |
1470 | description: Unauthenticated access. Please login first. | |
1471 | '403': | |
1472 | description: Unauthorized access. Please check your permissions. | |
1473 | '500': | |
1474 | description: Unexpected error. Please check the response body for the stack | |
1475 | trace. | |
1476 | security: | |
1477 | - jwt: [] | |
1478 | summary: Display Rbd Mirroring Summary | |
1479 | tags: | |
1480 | - RbdMirroringSummary | |
1481 | /api/block/pool/{pool_name}/namespace: | |
1482 | get: | |
1483 | parameters: | |
1484 | - in: path | |
1485 | name: pool_name | |
1486 | required: true | |
1487 | schema: | |
1488 | type: string | |
1489 | responses: | |
1490 | '200': | |
1491 | content: | |
1492 | application/vnd.ceph.api.v1.0+json: | |
1493 | type: object | |
1494 | description: OK | |
1495 | '400': | |
1496 | description: Operation exception. Please check the response body for details. | |
1497 | '401': | |
1498 | description: Unauthenticated access. Please login first. | |
1499 | '403': | |
1500 | description: Unauthorized access. Please check your permissions. | |
1501 | '500': | |
1502 | description: Unexpected error. Please check the response body for the stack | |
1503 | trace. | |
1504 | security: | |
1505 | - jwt: [] | |
1506 | tags: | |
1507 | - RbdNamespace | |
1508 | post: | |
1509 | parameters: | |
1510 | - in: path | |
1511 | name: pool_name | |
1512 | required: true | |
1513 | schema: | |
1514 | type: string | |
1515 | requestBody: | |
1516 | content: | |
1517 | application/json: | |
1518 | schema: | |
1519 | properties: | |
1520 | namespace: | |
1521 | type: string | |
1522 | required: | |
1523 | - namespace | |
1524 | type: object | |
1525 | responses: | |
1526 | '201': | |
1527 | content: | |
1528 | application/vnd.ceph.api.v1.0+json: | |
1529 | type: object | |
1530 | description: Resource created. | |
1531 | '202': | |
1532 | content: | |
1533 | application/vnd.ceph.api.v1.0+json: | |
1534 | type: object | |
1535 | description: Operation is still executing. Please check the task queue. | |
1536 | '400': | |
1537 | description: Operation exception. Please check the response body for details. | |
1538 | '401': | |
1539 | description: Unauthenticated access. Please login first. | |
1540 | '403': | |
1541 | description: Unauthorized access. Please check your permissions. | |
1542 | '500': | |
1543 | description: Unexpected error. Please check the response body for the stack | |
1544 | trace. | |
1545 | security: | |
1546 | - jwt: [] | |
1547 | tags: | |
1548 | - RbdNamespace | |
1549 | /api/block/pool/{pool_name}/namespace/{namespace}: | |
1550 | delete: | |
1551 | parameters: | |
1552 | - in: path | |
1553 | name: pool_name | |
1554 | required: true | |
1555 | schema: | |
1556 | type: string | |
1557 | - in: path | |
1558 | name: namespace | |
1559 | required: true | |
1560 | schema: | |
1561 | type: string | |
1562 | responses: | |
1563 | '202': | |
1564 | content: | |
1565 | application/vnd.ceph.api.v1.0+json: | |
1566 | type: object | |
1567 | description: Operation is still executing. Please check the task queue. | |
1568 | '204': | |
1569 | content: | |
1570 | application/vnd.ceph.api.v1.0+json: | |
1571 | type: object | |
1572 | description: Resource deleted. | |
1573 | '400': | |
1574 | description: Operation exception. Please check the response body for details. | |
1575 | '401': | |
1576 | description: Unauthenticated access. Please login first. | |
1577 | '403': | |
1578 | description: Unauthorized access. Please check your permissions. | |
1579 | '500': | |
1580 | description: Unexpected error. Please check the response body for the stack | |
1581 | trace. | |
1582 | security: | |
1583 | - jwt: [] | |
1584 | tags: | |
1585 | - RbdNamespace | |
1586 | /api/cephfs: | |
1587 | get: | |
1588 | parameters: [] | |
1589 | responses: | |
1590 | '200': | |
1591 | content: | |
1592 | application/vnd.ceph.api.v1.0+json: | |
1593 | type: object | |
1594 | description: OK | |
1595 | '400': | |
1596 | description: Operation exception. Please check the response body for details. | |
1597 | '401': | |
1598 | description: Unauthenticated access. Please login first. | |
1599 | '403': | |
1600 | description: Unauthorized access. Please check your permissions. | |
1601 | '500': | |
1602 | description: Unexpected error. Please check the response body for the stack | |
1603 | trace. | |
1604 | security: | |
1605 | - jwt: [] | |
1606 | tags: | |
1607 | - Cephfs | |
1608 | /api/cephfs/{fs_id}: | |
1609 | get: | |
1610 | parameters: | |
1611 | - in: path | |
1612 | name: fs_id | |
1613 | required: true | |
1614 | schema: | |
1615 | type: string | |
1616 | responses: | |
1617 | '200': | |
1618 | content: | |
1619 | application/vnd.ceph.api.v1.0+json: | |
1620 | type: object | |
1621 | description: OK | |
1622 | '400': | |
1623 | description: Operation exception. Please check the response body for details. | |
1624 | '401': | |
1625 | description: Unauthenticated access. Please login first. | |
1626 | '403': | |
1627 | description: Unauthorized access. Please check your permissions. | |
1628 | '500': | |
1629 | description: Unexpected error. Please check the response body for the stack | |
1630 | trace. | |
1631 | security: | |
1632 | - jwt: [] | |
1633 | tags: | |
1634 | - Cephfs | |
1635 | /api/cephfs/{fs_id}/client/{client_id}: | |
1636 | delete: | |
1637 | parameters: | |
1638 | - in: path | |
1639 | name: fs_id | |
1640 | required: true | |
1641 | schema: | |
1642 | type: string | |
1643 | - in: path | |
1644 | name: client_id | |
1645 | required: true | |
1646 | schema: | |
1647 | type: string | |
1648 | responses: | |
1649 | '202': | |
1650 | content: | |
1651 | application/vnd.ceph.api.v1.0+json: | |
1652 | type: object | |
1653 | description: Operation is still executing. Please check the task queue. | |
1654 | '204': | |
1655 | content: | |
1656 | application/vnd.ceph.api.v1.0+json: | |
1657 | type: object | |
1658 | description: Resource deleted. | |
1659 | '400': | |
1660 | description: Operation exception. Please check the response body for details. | |
1661 | '401': | |
1662 | description: Unauthenticated access. Please login first. | |
1663 | '403': | |
1664 | description: Unauthorized access. Please check your permissions. | |
1665 | '500': | |
1666 | description: Unexpected error. Please check the response body for the stack | |
1667 | trace. | |
1668 | security: | |
1669 | - jwt: [] | |
1670 | tags: | |
1671 | - Cephfs | |
1672 | /api/cephfs/{fs_id}/clients: | |
1673 | get: | |
1674 | parameters: | |
1675 | - in: path | |
1676 | name: fs_id | |
1677 | required: true | |
1678 | schema: | |
1679 | type: string | |
1680 | responses: | |
1681 | '200': | |
1682 | content: | |
1683 | application/vnd.ceph.api.v1.0+json: | |
1684 | type: object | |
1685 | description: OK | |
1686 | '400': | |
1687 | description: Operation exception. Please check the response body for details. | |
1688 | '401': | |
1689 | description: Unauthenticated access. Please login first. | |
1690 | '403': | |
1691 | description: Unauthorized access. Please check your permissions. | |
1692 | '500': | |
1693 | description: Unexpected error. Please check the response body for the stack | |
1694 | trace. | |
1695 | security: | |
1696 | - jwt: [] | |
1697 | tags: | |
1698 | - Cephfs | |
1699 | /api/cephfs/{fs_id}/get_root_directory: | |
1700 | get: | |
1701 | description: "\n The root directory that can't be fetched using ls_dir\ | |
1702 | \ (api).\n :param fs_id: The filesystem identifier.\n :return:\ | |
1703 | \ The root directory\n :rtype: dict\n " | |
1704 | parameters: | |
1705 | - in: path | |
1706 | name: fs_id | |
1707 | required: true | |
1708 | schema: | |
1709 | type: string | |
1710 | responses: | |
1711 | '200': | |
1712 | content: | |
1713 | application/vnd.ceph.api.v1.0+json: | |
1714 | type: object | |
1715 | description: OK | |
1716 | '400': | |
1717 | description: Operation exception. Please check the response body for details. | |
1718 | '401': | |
1719 | description: Unauthenticated access. Please login first. | |
1720 | '403': | |
1721 | description: Unauthorized access. Please check your permissions. | |
1722 | '500': | |
1723 | description: Unexpected error. Please check the response body for the stack | |
1724 | trace. | |
1725 | security: | |
1726 | - jwt: [] | |
1727 | tags: | |
1728 | - Cephfs | |
1729 | /api/cephfs/{fs_id}/ls_dir: | |
1730 | get: | |
1731 | description: "\n List directories of specified path.\n :param\ | |
1732 | \ fs_id: The filesystem identifier.\n :param path: The path where to\ | |
1733 | \ start listing the directory content.\n Defaults to '/' if not set.\n\ | |
1734 | \ :type path: str | bytes\n :param depth: The number of steps\ | |
1735 | \ to go down the directory tree.\n :type depth: int | str\n \ | |
1736 | \ :return: The names of the directories below the specified path.\n \ | |
1737 | \ :rtype: list\n " | |
1738 | parameters: | |
1739 | - in: path | |
1740 | name: fs_id | |
1741 | required: true | |
1742 | schema: | |
1743 | type: string | |
1744 | - allowEmptyValue: true | |
1745 | in: query | |
1746 | name: path | |
1747 | schema: | |
1748 | type: string | |
1749 | - default: 1 | |
1750 | in: query | |
1751 | name: depth | |
1752 | schema: | |
1753 | type: integer | |
1754 | responses: | |
1755 | '200': | |
1756 | content: | |
1757 | application/vnd.ceph.api.v1.0+json: | |
1758 | type: object | |
1759 | description: OK | |
1760 | '400': | |
1761 | description: Operation exception. Please check the response body for details. | |
1762 | '401': | |
1763 | description: Unauthenticated access. Please login first. | |
1764 | '403': | |
1765 | description: Unauthorized access. Please check your permissions. | |
1766 | '500': | |
1767 | description: Unexpected error. Please check the response body for the stack | |
1768 | trace. | |
1769 | security: | |
1770 | - jwt: [] | |
1771 | tags: | |
1772 | - Cephfs | |
1773 | /api/cephfs/{fs_id}/mds_counters: | |
1774 | get: | |
1775 | parameters: | |
1776 | - in: path | |
1777 | name: fs_id | |
1778 | required: true | |
1779 | schema: | |
1780 | type: string | |
1781 | - allowEmptyValue: true | |
1782 | in: query | |
1783 | name: counters | |
1784 | schema: | |
1785 | type: integer | |
1786 | responses: | |
1787 | '200': | |
1788 | content: | |
1789 | application/vnd.ceph.api.v1.0+json: | |
1790 | type: object | |
1791 | description: OK | |
1792 | '400': | |
1793 | description: Operation exception. Please check the response body for details. | |
1794 | '401': | |
1795 | description: Unauthenticated access. Please login first. | |
1796 | '403': | |
1797 | description: Unauthorized access. Please check your permissions. | |
1798 | '500': | |
1799 | description: Unexpected error. Please check the response body for the stack | |
1800 | trace. | |
1801 | security: | |
1802 | - jwt: [] | |
1803 | tags: | |
1804 | - Cephfs | |
1805 | /api/cephfs/{fs_id}/quota: | |
1806 | get: | |
1807 | description: "\n Get the quotas of the specified path.\n :param\ | |
1808 | \ fs_id: The filesystem identifier.\n :param path: The path of the\ | |
1809 | \ directory/file.\n :return: Returns a dictionary containing 'max_bytes'\n\ | |
1810 | \ and 'max_files'.\n :rtype: dict\n " | |
1811 | parameters: | |
1812 | - description: File System Identifier | |
1813 | in: path | |
1814 | name: fs_id | |
1815 | required: true | |
1816 | schema: | |
1817 | type: string | |
1818 | - description: File System Path | |
1819 | in: query | |
1820 | name: path | |
1821 | required: true | |
1822 | schema: | |
1823 | type: string | |
1824 | responses: | |
1825 | '200': | |
1826 | content: | |
1827 | application/vnd.ceph.api.v1.0+json: | |
1828 | schema: | |
1829 | properties: | |
1830 | max_bytes: | |
1831 | description: '' | |
1832 | type: integer | |
1833 | max_files: | |
1834 | description: '' | |
1835 | type: integer | |
1836 | required: | |
1837 | - max_bytes | |
1838 | - max_files | |
1839 | type: object | |
1840 | description: OK | |
1841 | '400': | |
1842 | description: Operation exception. Please check the response body for details. | |
1843 | '401': | |
1844 | description: Unauthenticated access. Please login first. | |
1845 | '403': | |
1846 | description: Unauthorized access. Please check your permissions. | |
1847 | '500': | |
1848 | description: Unexpected error. Please check the response body for the stack | |
1849 | trace. | |
1850 | security: | |
1851 | - jwt: [] | |
1852 | summary: Get Cephfs Quotas of the specified path | |
1853 | tags: | |
1854 | - Cephfs | |
1855 | put: | |
1856 | description: "\n Set the quotas of the specified path.\n :param\ | |
1857 | \ fs_id: The filesystem identifier.\n :param path: The path of the\ | |
1858 | \ directory/file.\n :param max_bytes: The byte limit.\n :param\ | |
1859 | \ max_files: The file limit.\n " | |
1860 | parameters: | |
1861 | - in: path | |
1862 | name: fs_id | |
1863 | required: true | |
1864 | schema: | |
1865 | type: string | |
1866 | requestBody: | |
1867 | content: | |
1868 | application/json: | |
1869 | schema: | |
1870 | properties: | |
1871 | max_bytes: | |
1872 | type: string | |
1873 | max_files: | |
1874 | type: string | |
1875 | path: | |
1876 | type: string | |
1877 | required: | |
1878 | - path | |
1879 | type: object | |
1880 | responses: | |
1881 | '200': | |
1882 | content: | |
1883 | application/vnd.ceph.api.v1.0+json: | |
1884 | type: object | |
1885 | description: Resource updated. | |
1886 | '202': | |
1887 | content: | |
1888 | application/vnd.ceph.api.v1.0+json: | |
1889 | type: object | |
1890 | description: Operation is still executing. Please check the task queue. | |
1891 | '400': | |
1892 | description: Operation exception. Please check the response body for details. | |
1893 | '401': | |
1894 | description: Unauthenticated access. Please login first. | |
1895 | '403': | |
1896 | description: Unauthorized access. Please check your permissions. | |
1897 | '500': | |
1898 | description: Unexpected error. Please check the response body for the stack | |
1899 | trace. | |
1900 | security: | |
1901 | - jwt: [] | |
1902 | tags: | |
1903 | - Cephfs | |
1904 | /api/cephfs/{fs_id}/snapshot: | |
1905 | delete: | |
1906 | description: "\n Remove a snapshot.\n :param fs_id: The filesystem\ | |
1907 | \ identifier.\n :param path: The path of the directory.\n :param\ | |
1908 | \ name: The name of the snapshot.\n " | |
1909 | parameters: | |
1910 | - in: path | |
1911 | name: fs_id | |
1912 | required: true | |
1913 | schema: | |
1914 | type: string | |
1915 | - in: query | |
1916 | name: path | |
1917 | required: true | |
1918 | schema: | |
1919 | type: string | |
1920 | - in: query | |
1921 | name: name | |
1922 | required: true | |
1923 | schema: | |
1924 | type: string | |
1925 | responses: | |
1926 | '202': | |
1927 | content: | |
1928 | application/vnd.ceph.api.v1.0+json: | |
1929 | type: object | |
1930 | description: Operation is still executing. Please check the task queue. | |
1931 | '204': | |
1932 | content: | |
1933 | application/vnd.ceph.api.v1.0+json: | |
1934 | type: object | |
1935 | description: Resource deleted. | |
1936 | '400': | |
1937 | description: Operation exception. Please check the response body for details. | |
1938 | '401': | |
1939 | description: Unauthenticated access. Please login first. | |
1940 | '403': | |
1941 | description: Unauthorized access. Please check your permissions. | |
1942 | '500': | |
1943 | description: Unexpected error. Please check the response body for the stack | |
1944 | trace. | |
1945 | security: | |
1946 | - jwt: [] | |
1947 | tags: | |
1948 | - Cephfs | |
1949 | post: | |
1950 | description: "\n Create a snapshot.\n :param fs_id: The filesystem\ | |
1951 | \ identifier.\n :param path: The path of the directory.\n :param\ | |
1952 | \ name: The name of the snapshot. If not specified, a name using the\n \ | |
1953 | \ current time in RFC3339 UTC format will be generated.\n :return:\ | |
1954 | \ The name of the snapshot.\n :rtype: str\n " | |
1955 | parameters: | |
1956 | - in: path | |
1957 | name: fs_id | |
1958 | required: true | |
1959 | schema: | |
1960 | type: string | |
1961 | requestBody: | |
1962 | content: | |
1963 | application/json: | |
1964 | schema: | |
1965 | properties: | |
1966 | name: | |
1967 | type: string | |
1968 | path: | |
1969 | type: string | |
1970 | required: | |
1971 | - path | |
1972 | type: object | |
1973 | responses: | |
1974 | '201': | |
1975 | content: | |
1976 | application/vnd.ceph.api.v1.0+json: | |
1977 | type: object | |
1978 | description: Resource created. | |
1979 | '202': | |
1980 | content: | |
1981 | application/vnd.ceph.api.v1.0+json: | |
1982 | type: object | |
1983 | description: Operation is still executing. Please check the task queue. | |
1984 | '400': | |
1985 | description: Operation exception. Please check the response body for details. | |
1986 | '401': | |
1987 | description: Unauthenticated access. Please login first. | |
1988 | '403': | |
1989 | description: Unauthorized access. Please check your permissions. | |
1990 | '500': | |
1991 | description: Unexpected error. Please check the response body for the stack | |
1992 | trace. | |
1993 | security: | |
1994 | - jwt: [] | |
1995 | tags: | |
1996 | - Cephfs | |
1997 | /api/cephfs/{fs_id}/tree: | |
1998 | delete: | |
1999 | description: "\n Remove a directory.\n :param fs_id: The filesystem\ | |
2000 | \ identifier.\n :param path: The path of the directory.\n " | |
2001 | parameters: | |
2002 | - in: path | |
2003 | name: fs_id | |
2004 | required: true | |
2005 | schema: | |
2006 | type: string | |
2007 | - in: query | |
2008 | name: path | |
2009 | required: true | |
2010 | schema: | |
2011 | type: string | |
2012 | responses: | |
2013 | '202': | |
2014 | content: | |
2015 | application/vnd.ceph.api.v1.0+json: | |
2016 | type: object | |
2017 | description: Operation is still executing. Please check the task queue. | |
2018 | '204': | |
2019 | content: | |
2020 | application/vnd.ceph.api.v1.0+json: | |
2021 | type: object | |
2022 | description: Resource deleted. | |
2023 | '400': | |
2024 | description: Operation exception. Please check the response body for details. | |
2025 | '401': | |
2026 | description: Unauthenticated access. Please login first. | |
2027 | '403': | |
2028 | description: Unauthorized access. Please check your permissions. | |
2029 | '500': | |
2030 | description: Unexpected error. Please check the response body for the stack | |
2031 | trace. | |
2032 | security: | |
2033 | - jwt: [] | |
2034 | tags: | |
2035 | - Cephfs | |
2036 | post: | |
2037 | description: "\n Create a directory.\n :param fs_id: The filesystem\ | |
2038 | \ identifier.\n :param path: The path of the directory.\n " | |
2039 | parameters: | |
2040 | - in: path | |
2041 | name: fs_id | |
2042 | required: true | |
2043 | schema: | |
2044 | type: string | |
2045 | requestBody: | |
2046 | content: | |
2047 | application/json: | |
2048 | schema: | |
2049 | properties: | |
2050 | path: | |
2051 | type: string | |
2052 | required: | |
2053 | - path | |
2054 | type: object | |
2055 | responses: | |
2056 | '201': | |
2057 | content: | |
2058 | application/vnd.ceph.api.v1.0+json: | |
2059 | type: object | |
2060 | description: Resource created. | |
2061 | '202': | |
2062 | content: | |
2063 | application/vnd.ceph.api.v1.0+json: | |
2064 | type: object | |
2065 | description: Operation is still executing. Please check the task queue. | |
2066 | '400': | |
2067 | description: Operation exception. Please check the response body for details. | |
2068 | '401': | |
2069 | description: Unauthenticated access. Please login first. | |
2070 | '403': | |
2071 | description: Unauthorized access. Please check your permissions. | |
2072 | '500': | |
2073 | description: Unexpected error. Please check the response body for the stack | |
2074 | trace. | |
2075 | security: | |
2076 | - jwt: [] | |
2077 | tags: | |
2078 | - Cephfs | |
a4b75251 TL |
2079 | /api/cluster: |
2080 | get: | |
2081 | parameters: [] | |
2082 | responses: | |
2083 | '200': | |
2084 | content: | |
2085 | application/vnd.ceph.api.v0.1+json: | |
2086 | type: object | |
2087 | description: OK | |
2088 | '400': | |
2089 | description: Operation exception. Please check the response body for details. | |
2090 | '401': | |
2091 | description: Unauthenticated access. Please login first. | |
2092 | '403': | |
2093 | description: Unauthorized access. Please check your permissions. | |
2094 | '500': | |
2095 | description: Unexpected error. Please check the response body for the stack | |
2096 | trace. | |
2097 | security: | |
2098 | - jwt: [] | |
2099 | summary: Get the cluster status | |
2100 | tags: | |
2101 | - Cluster | |
2102 | put: | |
2103 | parameters: [] | |
2104 | requestBody: | |
2105 | content: | |
2106 | application/json: | |
2107 | schema: | |
2108 | properties: | |
2109 | status: | |
2110 | description: Cluster Status | |
2111 | type: string | |
2112 | required: | |
2113 | - status | |
2114 | type: object | |
2115 | responses: | |
2116 | '200': | |
2117 | content: | |
2118 | application/vnd.ceph.api.v0.1+json: | |
2119 | type: object | |
2120 | description: Resource updated. | |
2121 | '202': | |
2122 | content: | |
2123 | application/vnd.ceph.api.v0.1+json: | |
2124 | type: object | |
2125 | description: Operation is still executing. Please check the task queue. | |
2126 | '400': | |
2127 | description: Operation exception. Please check the response body for details. | |
2128 | '401': | |
2129 | description: Unauthenticated access. Please login first. | |
2130 | '403': | |
2131 | description: Unauthorized access. Please check your permissions. | |
2132 | '500': | |
2133 | description: Unexpected error. Please check the response body for the stack | |
2134 | trace. | |
2135 | security: | |
2136 | - jwt: [] | |
2137 | summary: Update the cluster status | |
2138 | tags: | |
2139 | - Cluster | |
f67539c2 TL |
2140 | /api/cluster_conf: |
2141 | get: | |
2142 | parameters: [] | |
2143 | responses: | |
2144 | '200': | |
2145 | content: | |
2146 | application/vnd.ceph.api.v1.0+json: | |
2147 | type: object | |
2148 | description: OK | |
2149 | '400': | |
2150 | description: Operation exception. Please check the response body for details. | |
2151 | '401': | |
2152 | description: Unauthenticated access. Please login first. | |
2153 | '403': | |
2154 | description: Unauthorized access. Please check your permissions. | |
2155 | '500': | |
2156 | description: Unexpected error. Please check the response body for the stack | |
2157 | trace. | |
2158 | security: | |
2159 | - jwt: [] | |
2160 | tags: | |
2161 | - ClusterConfiguration | |
2162 | post: | |
2163 | parameters: [] | |
2164 | requestBody: | |
2165 | content: | |
2166 | application/json: | |
2167 | schema: | |
2168 | properties: | |
2169 | name: | |
2170 | type: string | |
2171 | value: | |
2172 | type: string | |
2173 | required: | |
2174 | - name | |
2175 | - value | |
2176 | type: object | |
2177 | responses: | |
2178 | '201': | |
2179 | content: | |
2180 | application/vnd.ceph.api.v1.0+json: | |
2181 | type: object | |
2182 | description: Resource created. | |
2183 | '202': | |
2184 | content: | |
2185 | application/vnd.ceph.api.v1.0+json: | |
2186 | type: object | |
2187 | description: Operation is still executing. Please check the task queue. | |
2188 | '400': | |
2189 | description: Operation exception. Please check the response body for details. | |
2190 | '401': | |
2191 | description: Unauthenticated access. Please login first. | |
2192 | '403': | |
2193 | description: Unauthorized access. Please check your permissions. | |
2194 | '500': | |
2195 | description: Unexpected error. Please check the response body for the stack | |
2196 | trace. | |
2197 | security: | |
2198 | - jwt: [] | |
2199 | tags: | |
2200 | - ClusterConfiguration | |
2201 | put: | |
2202 | parameters: [] | |
2203 | requestBody: | |
2204 | content: | |
2205 | application/json: | |
2206 | schema: | |
2207 | properties: | |
2208 | options: | |
2209 | type: string | |
2210 | required: | |
2211 | - options | |
2212 | type: object | |
2213 | responses: | |
2214 | '200': | |
2215 | content: | |
2216 | application/vnd.ceph.api.v1.0+json: | |
2217 | type: object | |
2218 | description: Resource updated. | |
2219 | '202': | |
2220 | content: | |
2221 | application/vnd.ceph.api.v1.0+json: | |
2222 | type: object | |
2223 | description: Operation is still executing. Please check the task queue. | |
2224 | '400': | |
2225 | description: Operation exception. Please check the response body for details. | |
2226 | '401': | |
2227 | description: Unauthenticated access. Please login first. | |
2228 | '403': | |
2229 | description: Unauthorized access. Please check your permissions. | |
2230 | '500': | |
2231 | description: Unexpected error. Please check the response body for the stack | |
2232 | trace. | |
2233 | security: | |
2234 | - jwt: [] | |
2235 | tags: | |
2236 | - ClusterConfiguration | |
2237 | /api/cluster_conf/filter: | |
2238 | get: | |
2239 | parameters: | |
2240 | - allowEmptyValue: true | |
2241 | description: Config option names | |
2242 | in: query | |
2243 | name: names | |
2244 | schema: | |
2245 | type: string | |
2246 | responses: | |
2247 | '200': | |
2248 | content: | |
2249 | application/vnd.ceph.api.v1.0+json: | |
2250 | schema: | |
2251 | items: | |
2252 | properties: | |
2253 | can_update_at_runtime: | |
2254 | description: Check if can update at runtime | |
2255 | type: boolean | |
2256 | daemon_default: | |
2257 | description: Daemon specific default value | |
2258 | type: string | |
2259 | default: | |
2260 | description: Default value for the config option | |
2261 | type: string | |
2262 | desc: | |
2263 | description: Description of the configuration | |
2264 | type: string | |
2265 | enum_values: | |
2266 | description: List of enums allowed | |
2267 | items: | |
2268 | type: string | |
2269 | type: array | |
2270 | flags: | |
2271 | description: List of flags associated | |
2272 | items: | |
2273 | type: string | |
2274 | type: array | |
2275 | level: | |
2276 | description: Config option level | |
2277 | type: string | |
2278 | long_desc: | |
2279 | description: Elaborated description | |
2280 | type: string | |
2281 | max: | |
2282 | description: Maximum value | |
2283 | type: string | |
2284 | min: | |
2285 | description: Minimum value | |
2286 | type: string | |
2287 | name: | |
2288 | description: Name of the config option | |
2289 | type: string | |
2290 | see_also: | |
2291 | description: Related config options | |
2292 | items: | |
2293 | type: string | |
2294 | type: array | |
2295 | services: | |
2296 | description: Services associated with the config option | |
2297 | items: | |
2298 | type: string | |
2299 | type: array | |
2300 | tags: | |
2301 | description: Tags associated with the cluster | |
2302 | items: | |
2303 | type: string | |
2304 | type: array | |
2305 | type: | |
2306 | description: Config option type | |
2307 | type: string | |
2308 | type: object | |
2309 | required: | |
2310 | - name | |
2311 | - type | |
2312 | - level | |
2313 | - desc | |
2314 | - long_desc | |
2315 | - default | |
2316 | - daemon_default | |
2317 | - tags | |
2318 | - services | |
2319 | - see_also | |
2320 | - enum_values | |
2321 | - min | |
2322 | - max | |
2323 | - can_update_at_runtime | |
2324 | - flags | |
2325 | type: array | |
2326 | description: OK | |
2327 | '400': | |
2328 | description: Operation exception. Please check the response body for details. | |
2329 | '401': | |
2330 | description: Unauthenticated access. Please login first. | |
2331 | '403': | |
2332 | description: Unauthorized access. Please check your permissions. | |
2333 | '500': | |
2334 | description: Unexpected error. Please check the response body for the stack | |
2335 | trace. | |
2336 | security: | |
2337 | - jwt: [] | |
2338 | summary: Get Cluster Configuration by name | |
2339 | tags: | |
2340 | - ClusterConfiguration | |
2341 | /api/cluster_conf/{name}: | |
2342 | delete: | |
2343 | parameters: | |
2344 | - in: path | |
2345 | name: name | |
2346 | required: true | |
2347 | schema: | |
2348 | type: string | |
2349 | - in: query | |
2350 | name: section | |
2351 | required: true | |
2352 | schema: | |
2353 | type: string | |
2354 | responses: | |
2355 | '202': | |
2356 | content: | |
2357 | application/vnd.ceph.api.v1.0+json: | |
2358 | type: object | |
2359 | description: Operation is still executing. Please check the task queue. | |
2360 | '204': | |
2361 | content: | |
2362 | application/vnd.ceph.api.v1.0+json: | |
2363 | type: object | |
2364 | description: Resource deleted. | |
2365 | '400': | |
2366 | description: Operation exception. Please check the response body for details. | |
2367 | '401': | |
2368 | description: Unauthenticated access. Please login first. | |
2369 | '403': | |
2370 | description: Unauthorized access. Please check your permissions. | |
2371 | '500': | |
2372 | description: Unexpected error. Please check the response body for the stack | |
2373 | trace. | |
2374 | security: | |
2375 | - jwt: [] | |
2376 | tags: | |
2377 | - ClusterConfiguration | |
2378 | get: | |
2379 | parameters: | |
2380 | - in: path | |
2381 | name: name | |
2382 | required: true | |
2383 | schema: | |
2384 | type: string | |
2385 | responses: | |
2386 | '200': | |
2387 | content: | |
2388 | application/vnd.ceph.api.v1.0+json: | |
2389 | type: object | |
2390 | description: OK | |
2391 | '400': | |
2392 | description: Operation exception. Please check the response body for details. | |
2393 | '401': | |
2394 | description: Unauthenticated access. Please login first. | |
2395 | '403': | |
2396 | description: Unauthorized access. Please check your permissions. | |
2397 | '500': | |
2398 | description: Unexpected error. Please check the response body for the stack | |
2399 | trace. | |
2400 | security: | |
2401 | - jwt: [] | |
2402 | tags: | |
2403 | - ClusterConfiguration | |
2404 | /api/crush_rule: | |
2405 | get: | |
2406 | parameters: [] | |
2407 | responses: | |
2408 | '200': | |
2409 | content: | |
20effc67 | 2410 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
2411 | schema: |
2412 | properties: | |
2413 | max_size: | |
2414 | description: Maximum size of Rule | |
2415 | type: integer | |
2416 | min_size: | |
2417 | description: Minimum size of Rule | |
2418 | type: integer | |
2419 | rule_id: | |
2420 | description: Rule ID | |
2421 | type: integer | |
2422 | rule_name: | |
2423 | description: Rule Name | |
2424 | type: string | |
2425 | ruleset: | |
2426 | description: RuleSet related to the rule | |
2427 | type: integer | |
2428 | steps: | |
2429 | description: Steps included in the rule | |
2430 | items: | |
2431 | type: object | |
2432 | type: array | |
2433 | type: | |
2434 | description: Type of Rule | |
2435 | type: integer | |
2436 | required: | |
2437 | - rule_id | |
2438 | - rule_name | |
2439 | - ruleset | |
2440 | - type | |
2441 | - min_size | |
2442 | - max_size | |
2443 | - steps | |
2444 | type: object | |
2445 | description: OK | |
2446 | '400': | |
2447 | description: Operation exception. Please check the response body for details. | |
2448 | '401': | |
2449 | description: Unauthenticated access. Please login first. | |
2450 | '403': | |
2451 | description: Unauthorized access. Please check your permissions. | |
2452 | '500': | |
2453 | description: Unexpected error. Please check the response body for the stack | |
2454 | trace. | |
2455 | security: | |
2456 | - jwt: [] | |
2457 | summary: List Crush Rule Configuration | |
2458 | tags: | |
2459 | - CrushRule | |
2460 | post: | |
2461 | parameters: [] | |
2462 | requestBody: | |
2463 | content: | |
2464 | application/json: | |
2465 | schema: | |
2466 | properties: | |
2467 | device_class: | |
2468 | type: string | |
2469 | failure_domain: | |
2470 | type: string | |
2471 | name: | |
2472 | type: string | |
2473 | root: | |
2474 | type: string | |
2475 | required: | |
2476 | - name | |
2477 | - root | |
2478 | - failure_domain | |
2479 | type: object | |
2480 | responses: | |
2481 | '201': | |
2482 | content: | |
2483 | application/vnd.ceph.api.v1.0+json: | |
2484 | type: object | |
2485 | description: Resource created. | |
2486 | '202': | |
2487 | content: | |
2488 | application/vnd.ceph.api.v1.0+json: | |
2489 | type: object | |
2490 | description: Operation is still executing. Please check the task queue. | |
2491 | '400': | |
2492 | description: Operation exception. Please check the response body for details. | |
2493 | '401': | |
2494 | description: Unauthenticated access. Please login first. | |
2495 | '403': | |
2496 | description: Unauthorized access. Please check your permissions. | |
2497 | '500': | |
2498 | description: Unexpected error. Please check the response body for the stack | |
2499 | trace. | |
2500 | security: | |
2501 | - jwt: [] | |
2502 | tags: | |
2503 | - CrushRule | |
2504 | /api/crush_rule/{name}: | |
2505 | delete: | |
2506 | parameters: | |
2507 | - in: path | |
2508 | name: name | |
2509 | required: true | |
2510 | schema: | |
2511 | type: string | |
2512 | responses: | |
2513 | '202': | |
2514 | content: | |
2515 | application/vnd.ceph.api.v1.0+json: | |
2516 | type: object | |
2517 | description: Operation is still executing. Please check the task queue. | |
2518 | '204': | |
2519 | content: | |
2520 | application/vnd.ceph.api.v1.0+json: | |
2521 | type: object | |
2522 | description: Resource deleted. | |
2523 | '400': | |
2524 | description: Operation exception. Please check the response body for details. | |
2525 | '401': | |
2526 | description: Unauthenticated access. Please login first. | |
2527 | '403': | |
2528 | description: Unauthorized access. Please check your permissions. | |
2529 | '500': | |
2530 | description: Unexpected error. Please check the response body for the stack | |
2531 | trace. | |
2532 | security: | |
2533 | - jwt: [] | |
2534 | tags: | |
2535 | - CrushRule | |
2536 | get: | |
2537 | parameters: | |
2538 | - in: path | |
2539 | name: name | |
2540 | required: true | |
2541 | schema: | |
2542 | type: string | |
2543 | responses: | |
2544 | '200': | |
2545 | content: | |
20effc67 | 2546 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
2547 | type: object |
2548 | description: OK | |
2549 | '400': | |
2550 | description: Operation exception. Please check the response body for details. | |
2551 | '401': | |
2552 | description: Unauthenticated access. Please login first. | |
2553 | '403': | |
2554 | description: Unauthorized access. Please check your permissions. | |
2555 | '500': | |
2556 | description: Unexpected error. Please check the response body for the stack | |
2557 | trace. | |
2558 | security: | |
2559 | - jwt: [] | |
2560 | tags: | |
2561 | - CrushRule | |
20effc67 TL |
2562 | /api/daemon/{daemon_name}: |
2563 | put: | |
2564 | parameters: | |
2565 | - in: path | |
2566 | name: daemon_name | |
2567 | required: true | |
2568 | schema: | |
2569 | type: string | |
2570 | requestBody: | |
2571 | content: | |
2572 | application/json: | |
2573 | schema: | |
2574 | properties: | |
2575 | action: | |
2576 | default: '' | |
2577 | type: string | |
2578 | container_image: | |
2579 | type: string | |
2580 | type: object | |
2581 | responses: | |
2582 | '200': | |
2583 | content: | |
2584 | application/vnd.ceph.api.v0.1+json: | |
2585 | type: object | |
2586 | description: Resource updated. | |
2587 | '202': | |
2588 | content: | |
2589 | application/vnd.ceph.api.v0.1+json: | |
2590 | type: object | |
2591 | description: Operation is still executing. Please check the task queue. | |
2592 | '400': | |
2593 | description: Operation exception. Please check the response body for details. | |
2594 | '401': | |
2595 | description: Unauthenticated access. Please login first. | |
2596 | '403': | |
2597 | description: Unauthorized access. Please check your permissions. | |
2598 | '500': | |
2599 | description: Unexpected error. Please check the response body for the stack | |
2600 | trace. | |
2601 | security: | |
2602 | - jwt: [] | |
2603 | tags: | |
2604 | - Daemon | |
f67539c2 TL |
2605 | /api/erasure_code_profile: |
2606 | get: | |
2607 | parameters: [] | |
2608 | responses: | |
2609 | '200': | |
2610 | content: | |
2611 | application/vnd.ceph.api.v1.0+json: | |
2612 | schema: | |
2613 | items: | |
2614 | properties: | |
2615 | crush-failure-domain: | |
2616 | description: '' | |
2617 | type: string | |
2618 | k: | |
2619 | description: Number of data chunks | |
2620 | type: integer | |
2621 | m: | |
2622 | description: Number of coding chunks | |
2623 | type: integer | |
2624 | name: | |
2625 | description: Name of the profile | |
2626 | type: string | |
2627 | plugin: | |
2628 | description: Plugin Info | |
2629 | type: string | |
2630 | technique: | |
2631 | description: '' | |
2632 | type: string | |
2633 | type: object | |
2634 | required: | |
2635 | - crush-failure-domain | |
2636 | - k | |
2637 | - m | |
2638 | - plugin | |
2639 | - technique | |
2640 | - name | |
2641 | type: array | |
2642 | description: OK | |
2643 | '400': | |
2644 | description: Operation exception. Please check the response body for details. | |
2645 | '401': | |
2646 | description: Unauthenticated access. Please login first. | |
2647 | '403': | |
2648 | description: Unauthorized access. Please check your permissions. | |
2649 | '500': | |
2650 | description: Unexpected error. Please check the response body for the stack | |
2651 | trace. | |
2652 | security: | |
2653 | - jwt: [] | |
2654 | summary: List Erasure Code Profile Information | |
2655 | tags: | |
2656 | - ErasureCodeProfile | |
2657 | post: | |
2658 | parameters: [] | |
2659 | requestBody: | |
2660 | content: | |
2661 | application/json: | |
2662 | schema: | |
2663 | properties: | |
2664 | name: | |
2665 | type: string | |
2666 | required: | |
2667 | - name | |
2668 | type: object | |
2669 | responses: | |
2670 | '201': | |
2671 | content: | |
2672 | application/vnd.ceph.api.v1.0+json: | |
2673 | type: object | |
2674 | description: Resource created. | |
2675 | '202': | |
2676 | content: | |
2677 | application/vnd.ceph.api.v1.0+json: | |
2678 | type: object | |
2679 | description: Operation is still executing. Please check the task queue. | |
2680 | '400': | |
2681 | description: Operation exception. Please check the response body for details. | |
2682 | '401': | |
2683 | description: Unauthenticated access. Please login first. | |
2684 | '403': | |
2685 | description: Unauthorized access. Please check your permissions. | |
2686 | '500': | |
2687 | description: Unexpected error. Please check the response body for the stack | |
2688 | trace. | |
2689 | security: | |
2690 | - jwt: [] | |
2691 | tags: | |
2692 | - ErasureCodeProfile | |
2693 | /api/erasure_code_profile/{name}: | |
2694 | delete: | |
2695 | parameters: | |
2696 | - in: path | |
2697 | name: name | |
2698 | required: true | |
2699 | schema: | |
2700 | type: string | |
2701 | responses: | |
2702 | '202': | |
2703 | content: | |
2704 | application/vnd.ceph.api.v1.0+json: | |
2705 | type: object | |
2706 | description: Operation is still executing. Please check the task queue. | |
2707 | '204': | |
2708 | content: | |
2709 | application/vnd.ceph.api.v1.0+json: | |
2710 | type: object | |
2711 | description: Resource deleted. | |
2712 | '400': | |
2713 | description: Operation exception. Please check the response body for details. | |
2714 | '401': | |
2715 | description: Unauthenticated access. Please login first. | |
2716 | '403': | |
2717 | description: Unauthorized access. Please check your permissions. | |
2718 | '500': | |
2719 | description: Unexpected error. Please check the response body for the stack | |
2720 | trace. | |
2721 | security: | |
2722 | - jwt: [] | |
2723 | tags: | |
2724 | - ErasureCodeProfile | |
2725 | get: | |
2726 | parameters: | |
2727 | - in: path | |
2728 | name: name | |
2729 | required: true | |
2730 | schema: | |
2731 | type: string | |
2732 | responses: | |
2733 | '200': | |
2734 | content: | |
2735 | application/vnd.ceph.api.v1.0+json: | |
2736 | type: object | |
2737 | description: OK | |
2738 | '400': | |
2739 | description: Operation exception. Please check the response body for details. | |
2740 | '401': | |
2741 | description: Unauthenticated access. Please login first. | |
2742 | '403': | |
2743 | description: Unauthorized access. Please check your permissions. | |
2744 | '500': | |
2745 | description: Unexpected error. Please check the response body for the stack | |
2746 | trace. | |
2747 | security: | |
2748 | - jwt: [] | |
2749 | tags: | |
2750 | - ErasureCodeProfile | |
2751 | /api/feature_toggles: | |
2752 | get: | |
2753 | parameters: [] | |
2754 | responses: | |
2755 | '200': | |
2756 | content: | |
2757 | application/vnd.ceph.api.v1.0+json: | |
2758 | schema: | |
2759 | properties: | |
2760 | cephfs: | |
2761 | description: '' | |
2762 | type: boolean | |
2763 | iscsi: | |
2764 | description: '' | |
2765 | type: boolean | |
2766 | mirroring: | |
2767 | description: '' | |
2768 | type: boolean | |
2769 | nfs: | |
2770 | description: '' | |
2771 | type: boolean | |
2772 | rbd: | |
2773 | description: '' | |
2774 | type: boolean | |
2775 | rgw: | |
2776 | description: '' | |
2777 | type: boolean | |
2778 | required: | |
2779 | - rbd | |
2780 | - mirroring | |
2781 | - iscsi | |
2782 | - cephfs | |
2783 | - rgw | |
2784 | - nfs | |
2785 | type: object | |
2786 | description: OK | |
2787 | '400': | |
2788 | description: Operation exception. Please check the response body for details. | |
2789 | '401': | |
2790 | description: Unauthenticated access. Please login first. | |
2791 | '403': | |
2792 | description: Unauthorized access. Please check your permissions. | |
2793 | '500': | |
2794 | description: Unexpected error. Please check the response body for the stack | |
2795 | trace. | |
2796 | security: | |
2797 | - jwt: [] | |
2798 | summary: Get List Of Features | |
2799 | tags: | |
2800 | - FeatureTogglesEndpoint | |
20effc67 TL |
2801 | /api/feedback: |
2802 | get: | |
2803 | description: "\n List all issues details.\n " | |
2804 | parameters: [] | |
2805 | responses: | |
2806 | '200': | |
2807 | content: | |
2808 | application/vnd.ceph.api.v0.1+json: | |
2809 | type: object | |
2810 | description: OK | |
2811 | '400': | |
2812 | description: Operation exception. Please check the response body for details. | |
2813 | '401': | |
2814 | description: Unauthenticated access. Please login first. | |
2815 | '403': | |
2816 | description: Unauthorized access. Please check your permissions. | |
2817 | '500': | |
2818 | description: Unexpected error. Please check the response body for the stack | |
2819 | trace. | |
2820 | security: | |
2821 | - jwt: [] | |
2822 | tags: | |
2823 | - Report | |
2824 | post: | |
2825 | description: "\n Create an issue.\n :param project: The affected\ | |
2826 | \ ceph component.\n :param tracker: The tracker type.\n :param\ | |
2827 | \ subject: The title of the issue.\n :param description: The description\ | |
2828 | \ of the issue.\n :param api_key: Ceph tracker api key.\n " | |
2829 | parameters: [] | |
2830 | requestBody: | |
2831 | content: | |
2832 | application/json: | |
2833 | schema: | |
2834 | properties: | |
2835 | api_key: | |
2836 | type: string | |
2837 | description: | |
2838 | type: string | |
2839 | project: | |
2840 | type: string | |
2841 | subject: | |
2842 | type: string | |
2843 | tracker: | |
2844 | type: string | |
2845 | required: | |
2846 | - project | |
2847 | - tracker | |
2848 | - subject | |
2849 | - description | |
2850 | type: object | |
2851 | responses: | |
2852 | '201': | |
2853 | content: | |
2854 | application/vnd.ceph.api.v0.1+json: | |
2855 | type: object | |
2856 | description: Resource created. | |
2857 | '202': | |
2858 | content: | |
2859 | application/vnd.ceph.api.v0.1+json: | |
2860 | type: object | |
2861 | description: Operation is still executing. Please check the task queue. | |
2862 | '400': | |
2863 | description: Operation exception. Please check the response body for details. | |
2864 | '401': | |
2865 | description: Unauthenticated access. Please login first. | |
2866 | '403': | |
2867 | description: Unauthorized access. Please check your permissions. | |
2868 | '500': | |
2869 | description: Unexpected error. Please check the response body for the stack | |
2870 | trace. | |
2871 | security: | |
2872 | - jwt: [] | |
2873 | tags: | |
2874 | - Report | |
2875 | /api/feedback/api_key: | |
2876 | delete: | |
2877 | description: "\n Deletes Ceph tracker API key.\n " | |
2878 | parameters: [] | |
2879 | responses: | |
2880 | '202': | |
2881 | content: | |
2882 | application/vnd.ceph.api.v0.1+json: | |
2883 | type: object | |
2884 | description: Operation is still executing. Please check the task queue. | |
2885 | '204': | |
2886 | content: | |
2887 | application/vnd.ceph.api.v0.1+json: | |
2888 | type: object | |
2889 | description: Resource deleted. | |
2890 | '400': | |
2891 | description: Operation exception. Please check the response body for details. | |
2892 | '401': | |
2893 | description: Unauthenticated access. Please login first. | |
2894 | '403': | |
2895 | description: Unauthorized access. Please check your permissions. | |
2896 | '500': | |
2897 | description: Unexpected error. Please check the response body for the stack | |
2898 | trace. | |
2899 | security: | |
2900 | - jwt: [] | |
2901 | tags: | |
2902 | - Report | |
2903 | get: | |
2904 | description: "\n Returns Ceph tracker API key.\n " | |
2905 | parameters: [] | |
2906 | responses: | |
2907 | '200': | |
2908 | content: | |
2909 | application/vnd.ceph.api.v0.1+json: | |
2910 | type: object | |
2911 | description: OK | |
2912 | '400': | |
2913 | description: Operation exception. Please check the response body for details. | |
2914 | '401': | |
2915 | description: Unauthenticated access. Please login first. | |
2916 | '403': | |
2917 | description: Unauthorized access. Please check your permissions. | |
2918 | '500': | |
2919 | description: Unexpected error. Please check the response body for the stack | |
2920 | trace. | |
2921 | security: | |
2922 | - jwt: [] | |
2923 | tags: | |
2924 | - Report | |
2925 | post: | |
2926 | description: "\n Sets Ceph tracker API key.\n :param api_key:\ | |
2927 | \ The Ceph tracker API key.\n " | |
2928 | parameters: [] | |
2929 | requestBody: | |
2930 | content: | |
2931 | application/json: | |
2932 | schema: | |
2933 | properties: | |
2934 | api_key: | |
2935 | type: string | |
2936 | required: | |
2937 | - api_key | |
2938 | type: object | |
2939 | responses: | |
2940 | '201': | |
2941 | content: | |
2942 | application/vnd.ceph.api.v0.1+json: | |
2943 | type: object | |
2944 | description: Resource created. | |
2945 | '202': | |
2946 | content: | |
2947 | application/vnd.ceph.api.v0.1+json: | |
2948 | type: object | |
2949 | description: Operation is still executing. Please check the task queue. | |
2950 | '400': | |
2951 | description: Operation exception. Please check the response body for details. | |
2952 | '401': | |
2953 | description: Unauthenticated access. Please login first. | |
2954 | '403': | |
2955 | description: Unauthorized access. Please check your permissions. | |
2956 | '500': | |
2957 | description: Unexpected error. Please check the response body for the stack | |
2958 | trace. | |
2959 | security: | |
2960 | - jwt: [] | |
2961 | tags: | |
2962 | - Report | |
f67539c2 TL |
2963 | /api/grafana/dashboards: |
2964 | post: | |
2965 | parameters: [] | |
2966 | responses: | |
2967 | '201': | |
2968 | content: | |
2969 | application/vnd.ceph.api.v1.0+json: | |
2970 | type: object | |
2971 | description: Resource created. | |
2972 | '202': | |
2973 | content: | |
2974 | application/vnd.ceph.api.v1.0+json: | |
2975 | type: object | |
2976 | description: Operation is still executing. Please check the task queue. | |
2977 | '400': | |
2978 | description: Operation exception. Please check the response body for details. | |
2979 | '401': | |
2980 | description: Unauthenticated access. Please login first. | |
2981 | '403': | |
2982 | description: Unauthorized access. Please check your permissions. | |
2983 | '500': | |
2984 | description: Unexpected error. Please check the response body for the stack | |
2985 | trace. | |
2986 | security: | |
2987 | - jwt: [] | |
2988 | tags: | |
2989 | - Grafana | |
2990 | /api/grafana/url: | |
2991 | get: | |
2992 | parameters: [] | |
2993 | responses: | |
2994 | '200': | |
2995 | content: | |
2996 | application/vnd.ceph.api.v1.0+json: | |
2997 | schema: | |
2998 | properties: | |
2999 | instance: | |
3000 | description: grafana instance | |
3001 | type: string | |
3002 | required: | |
3003 | - instance | |
3004 | type: object | |
3005 | description: OK | |
3006 | '400': | |
3007 | description: Operation exception. Please check the response body for details. | |
3008 | '401': | |
3009 | description: Unauthenticated access. Please login first. | |
3010 | '403': | |
3011 | description: Unauthorized access. Please check your permissions. | |
3012 | '500': | |
3013 | description: Unexpected error. Please check the response body for the stack | |
3014 | trace. | |
3015 | security: | |
3016 | - jwt: [] | |
3017 | summary: List Grafana URL Instance | |
3018 | tags: | |
3019 | - Grafana | |
3020 | /api/grafana/validation/{params}: | |
3021 | get: | |
3022 | parameters: | |
3023 | - in: path | |
3024 | name: params | |
3025 | required: true | |
3026 | schema: | |
3027 | type: string | |
3028 | responses: | |
3029 | '200': | |
3030 | content: | |
3031 | application/vnd.ceph.api.v1.0+json: | |
3032 | type: object | |
3033 | description: OK | |
3034 | '400': | |
3035 | description: Operation exception. Please check the response body for details. | |
3036 | '401': | |
3037 | description: Unauthenticated access. Please login first. | |
3038 | '403': | |
3039 | description: Unauthorized access. Please check your permissions. | |
3040 | '500': | |
3041 | description: Unexpected error. Please check the response body for the stack | |
3042 | trace. | |
3043 | security: | |
3044 | - jwt: [] | |
3045 | tags: | |
3046 | - Grafana | |
3047 | /api/health/full: | |
3048 | get: | |
3049 | parameters: [] | |
3050 | responses: | |
3051 | '200': | |
3052 | content: | |
3053 | application/vnd.ceph.api.v1.0+json: | |
3054 | type: object | |
3055 | description: OK | |
3056 | '400': | |
3057 | description: Operation exception. Please check the response body for details. | |
3058 | '401': | |
3059 | description: Unauthenticated access. Please login first. | |
3060 | '403': | |
3061 | description: Unauthorized access. Please check your permissions. | |
3062 | '500': | |
3063 | description: Unexpected error. Please check the response body for the stack | |
3064 | trace. | |
3065 | security: | |
3066 | - jwt: [] | |
3067 | tags: | |
3068 | - Health | |
3069 | /api/health/minimal: | |
3070 | get: | |
3071 | parameters: [] | |
3072 | responses: | |
3073 | '200': | |
3074 | content: | |
3075 | application/vnd.ceph.api.v1.0+json: | |
3076 | schema: | |
3077 | properties: | |
3078 | client_perf: | |
3079 | description: '' | |
3080 | properties: | |
3081 | read_bytes_sec: | |
3082 | description: '' | |
3083 | type: integer | |
3084 | read_op_per_sec: | |
3085 | description: '' | |
3086 | type: integer | |
3087 | recovering_bytes_per_sec: | |
3088 | description: '' | |
3089 | type: integer | |
3090 | write_bytes_sec: | |
3091 | description: '' | |
3092 | type: integer | |
3093 | write_op_per_sec: | |
3094 | description: '' | |
3095 | type: integer | |
3096 | required: | |
3097 | - read_bytes_sec | |
3098 | - read_op_per_sec | |
3099 | - recovering_bytes_per_sec | |
3100 | - write_bytes_sec | |
3101 | - write_op_per_sec | |
3102 | type: object | |
3103 | df: | |
3104 | description: '' | |
3105 | properties: | |
3106 | stats: | |
3107 | description: '' | |
3108 | properties: | |
3109 | total_avail_bytes: | |
3110 | description: '' | |
3111 | type: integer | |
3112 | total_bytes: | |
3113 | description: '' | |
3114 | type: integer | |
3115 | total_used_raw_bytes: | |
3116 | description: '' | |
3117 | type: integer | |
3118 | required: | |
3119 | - total_avail_bytes | |
3120 | - total_bytes | |
3121 | - total_used_raw_bytes | |
3122 | type: object | |
3123 | required: | |
3124 | - stats | |
3125 | type: object | |
3126 | fs_map: | |
3127 | description: '' | |
3128 | properties: | |
3129 | filesystems: | |
3130 | description: '' | |
3131 | items: | |
3132 | properties: | |
3133 | mdsmap: | |
3134 | description: '' | |
3135 | properties: | |
3136 | balancer: | |
3137 | description: '' | |
3138 | type: string | |
3139 | compat: | |
3140 | description: '' | |
3141 | properties: | |
3142 | compat: | |
3143 | description: '' | |
3144 | type: string | |
3145 | incompat: | |
3146 | description: '' | |
3147 | type: string | |
3148 | ro_compat: | |
3149 | description: '' | |
3150 | type: string | |
3151 | required: | |
3152 | - compat | |
3153 | - ro_compat | |
3154 | - incompat | |
3155 | type: object | |
3156 | created: | |
3157 | description: '' | |
3158 | type: string | |
3159 | damaged: | |
3160 | description: '' | |
3161 | items: | |
3162 | type: integer | |
3163 | type: array | |
3164 | data_pools: | |
3165 | description: '' | |
3166 | items: | |
3167 | type: integer | |
3168 | type: array | |
3169 | enabled: | |
3170 | description: '' | |
3171 | type: boolean | |
3172 | epoch: | |
3173 | description: '' | |
3174 | type: integer | |
3175 | ever_allowed_features: | |
3176 | description: '' | |
3177 | type: integer | |
3178 | explicitly_allowed_features: | |
3179 | description: '' | |
3180 | type: integer | |
3181 | failed: | |
3182 | description: '' | |
3183 | items: | |
3184 | type: integer | |
3185 | type: array | |
3186 | flags: | |
3187 | description: '' | |
3188 | type: integer | |
3189 | fs_name: | |
3190 | description: '' | |
3191 | type: string | |
3192 | in: | |
3193 | description: '' | |
3194 | items: | |
3195 | type: integer | |
3196 | type: array | |
3197 | info: | |
3198 | description: '' | |
3199 | type: string | |
3200 | last_failure: | |
3201 | description: '' | |
3202 | type: integer | |
3203 | last_failure_osd_epoch: | |
3204 | description: '' | |
3205 | type: integer | |
3206 | max_file_size: | |
3207 | description: '' | |
3208 | type: integer | |
3209 | max_mds: | |
3210 | description: '' | |
3211 | type: integer | |
3212 | metadata_pool: | |
3213 | description: '' | |
3214 | type: integer | |
3215 | modified: | |
3216 | description: '' | |
3217 | type: string | |
3218 | required_client_features: | |
3219 | description: '' | |
3220 | type: string | |
3221 | root: | |
3222 | description: '' | |
3223 | type: integer | |
3224 | session_autoclose: | |
3225 | description: '' | |
3226 | type: integer | |
3227 | session_timeout: | |
3228 | description: '' | |
3229 | type: integer | |
3230 | standby_count_wanted: | |
3231 | description: '' | |
3232 | type: integer | |
3233 | stopped: | |
3234 | description: '' | |
3235 | items: | |
3236 | type: integer | |
3237 | type: array | |
3238 | tableserver: | |
3239 | description: '' | |
3240 | type: integer | |
3241 | up: | |
3242 | description: '' | |
3243 | type: string | |
3244 | required: | |
3245 | - session_autoclose | |
3246 | - balancer | |
3247 | - up | |
3248 | - last_failure_osd_epoch | |
3249 | - in | |
3250 | - last_failure | |
3251 | - max_file_size | |
3252 | - explicitly_allowed_features | |
3253 | - damaged | |
3254 | - tableserver | |
3255 | - failed | |
3256 | - metadata_pool | |
3257 | - epoch | |
3258 | - stopped | |
3259 | - max_mds | |
3260 | - compat | |
3261 | - required_client_features | |
3262 | - data_pools | |
3263 | - info | |
3264 | - fs_name | |
3265 | - created | |
3266 | - standby_count_wanted | |
3267 | - enabled | |
3268 | - modified | |
3269 | - session_timeout | |
3270 | - flags | |
3271 | - ever_allowed_features | |
3272 | - root | |
3273 | type: object | |
3274 | standbys: | |
3275 | description: '' | |
3276 | type: string | |
3277 | required: | |
3278 | - mdsmap | |
3279 | - standbys | |
3280 | type: object | |
3281 | type: array | |
3282 | required: | |
3283 | - filesystems | |
3284 | type: object | |
3285 | health: | |
3286 | description: '' | |
3287 | properties: | |
3288 | checks: | |
3289 | description: '' | |
3290 | type: string | |
3291 | mutes: | |
3292 | description: '' | |
3293 | type: string | |
3294 | status: | |
3295 | description: '' | |
3296 | type: string | |
3297 | required: | |
3298 | - checks | |
3299 | - mutes | |
3300 | - status | |
3301 | type: object | |
3302 | hosts: | |
3303 | description: '' | |
3304 | type: integer | |
3305 | iscsi_daemons: | |
3306 | description: '' | |
3307 | properties: | |
3308 | down: | |
3309 | description: '' | |
3310 | type: integer | |
3311 | up: | |
3312 | description: '' | |
3313 | type: integer | |
3314 | required: | |
3315 | - up | |
3316 | - down | |
3317 | type: object | |
3318 | mgr_map: | |
3319 | description: '' | |
3320 | properties: | |
3321 | active_name: | |
3322 | description: '' | |
3323 | type: string | |
3324 | standbys: | |
3325 | description: '' | |
3326 | type: string | |
3327 | required: | |
3328 | - active_name | |
3329 | - standbys | |
3330 | type: object | |
3331 | mon_status: | |
3332 | description: '' | |
3333 | properties: | |
3334 | monmap: | |
3335 | description: '' | |
3336 | properties: | |
3337 | mons: | |
3338 | description: '' | |
3339 | type: string | |
3340 | required: | |
3341 | - mons | |
3342 | type: object | |
3343 | quorum: | |
3344 | description: '' | |
3345 | items: | |
3346 | type: integer | |
3347 | type: array | |
3348 | required: | |
3349 | - monmap | |
3350 | - quorum | |
3351 | type: object | |
3352 | osd_map: | |
3353 | description: '' | |
3354 | properties: | |
3355 | osds: | |
3356 | description: '' | |
3357 | items: | |
3358 | properties: | |
3359 | in: | |
3360 | description: '' | |
3361 | type: integer | |
3362 | up: | |
3363 | description: '' | |
3364 | type: integer | |
3365 | required: | |
3366 | - in | |
3367 | - up | |
3368 | type: object | |
3369 | type: array | |
3370 | required: | |
3371 | - osds | |
3372 | type: object | |
3373 | pg_info: | |
3374 | description: '' | |
3375 | properties: | |
3376 | object_stats: | |
3377 | description: '' | |
3378 | properties: | |
3379 | num_object_copies: | |
3380 | description: '' | |
3381 | type: integer | |
3382 | num_objects: | |
3383 | description: '' | |
3384 | type: integer | |
3385 | num_objects_degraded: | |
3386 | description: '' | |
3387 | type: integer | |
3388 | num_objects_misplaced: | |
3389 | description: '' | |
3390 | type: integer | |
3391 | num_objects_unfound: | |
3392 | description: '' | |
3393 | type: integer | |
3394 | required: | |
3395 | - num_objects | |
3396 | - num_object_copies | |
3397 | - num_objects_degraded | |
3398 | - num_objects_misplaced | |
3399 | - num_objects_unfound | |
3400 | type: object | |
3401 | pgs_per_osd: | |
3402 | description: '' | |
3403 | type: integer | |
3404 | statuses: | |
3405 | description: '' | |
3406 | type: string | |
3407 | required: | |
3408 | - object_stats | |
3409 | - pgs_per_osd | |
3410 | - statuses | |
3411 | type: object | |
3412 | pools: | |
3413 | description: '' | |
3414 | type: string | |
3415 | rgw: | |
3416 | description: '' | |
3417 | type: integer | |
3418 | scrub_status: | |
3419 | description: '' | |
3420 | type: string | |
3421 | required: | |
3422 | - client_perf | |
3423 | - df | |
3424 | - fs_map | |
3425 | - health | |
3426 | - hosts | |
3427 | - iscsi_daemons | |
3428 | - mgr_map | |
3429 | - mon_status | |
3430 | - osd_map | |
3431 | - pg_info | |
3432 | - pools | |
3433 | - rgw | |
3434 | - scrub_status | |
3435 | type: object | |
3436 | description: OK | |
3437 | '400': | |
3438 | description: Operation exception. Please check the response body for details. | |
3439 | '401': | |
3440 | description: Unauthenticated access. Please login first. | |
3441 | '403': | |
3442 | description: Unauthorized access. Please check your permissions. | |
3443 | '500': | |
3444 | description: Unexpected error. Please check the response body for the stack | |
3445 | trace. | |
3446 | security: | |
3447 | - jwt: [] | |
3448 | summary: Get Cluster's minimal health report | |
3449 | tags: | |
3450 | - Health | |
3451 | /api/host: | |
3452 | get: | |
3453 | parameters: | |
3454 | - allowEmptyValue: true | |
3455 | description: Host Sources | |
3456 | in: query | |
3457 | name: sources | |
3458 | schema: | |
3459 | type: string | |
a4b75251 TL |
3460 | - default: false |
3461 | description: Host Facts | |
3462 | in: query | |
3463 | name: facts | |
3464 | schema: | |
3465 | type: boolean | |
f67539c2 TL |
3466 | responses: |
3467 | '200': | |
3468 | content: | |
39ae355f | 3469 | application/vnd.ceph.api.v1.2+json: |
f67539c2 TL |
3470 | schema: |
3471 | properties: | |
3472 | addr: | |
3473 | description: Host address | |
3474 | type: string | |
3475 | ceph_version: | |
3476 | description: Ceph version | |
3477 | type: string | |
3478 | hostname: | |
3479 | description: Hostname | |
3480 | type: string | |
3481 | labels: | |
3482 | description: Labels related to the host | |
3483 | items: | |
3484 | type: string | |
3485 | type: array | |
39ae355f TL |
3486 | service_instances: |
3487 | description: Service instances related to the host | |
3488 | items: | |
3489 | properties: | |
3490 | count: | |
3491 | description: Number of instances of the service | |
3492 | type: integer | |
3493 | type: | |
3494 | description: type of service | |
3495 | type: string | |
3496 | required: | |
3497 | - type | |
3498 | - count | |
3499 | type: object | |
3500 | type: array | |
f67539c2 TL |
3501 | service_type: |
3502 | description: '' | |
3503 | type: string | |
3504 | services: | |
3505 | description: Services related to the host | |
3506 | items: | |
3507 | properties: | |
3508 | id: | |
3509 | description: Service Id | |
3510 | type: string | |
3511 | type: | |
3512 | description: type of service | |
3513 | type: string | |
3514 | required: | |
3515 | - type | |
3516 | - id | |
3517 | type: object | |
3518 | type: array | |
3519 | sources: | |
3520 | description: Host Sources | |
3521 | properties: | |
3522 | ceph: | |
3523 | description: '' | |
3524 | type: boolean | |
3525 | orchestrator: | |
3526 | description: '' | |
3527 | type: boolean | |
3528 | required: | |
3529 | - ceph | |
3530 | - orchestrator | |
3531 | type: object | |
3532 | status: | |
3533 | description: '' | |
3534 | type: string | |
3535 | required: | |
3536 | - hostname | |
3537 | - services | |
39ae355f | 3538 | - service_instances |
f67539c2 TL |
3539 | - ceph_version |
3540 | - addr | |
3541 | - labels | |
3542 | - service_type | |
3543 | - sources | |
3544 | - status | |
3545 | type: object | |
3546 | description: OK | |
3547 | '400': | |
3548 | description: Operation exception. Please check the response body for details. | |
3549 | '401': | |
3550 | description: Unauthenticated access. Please login first. | |
3551 | '403': | |
3552 | description: Unauthorized access. Please check your permissions. | |
3553 | '500': | |
3554 | description: Unexpected error. Please check the response body for the stack | |
3555 | trace. | |
3556 | security: | |
3557 | - jwt: [] | |
3558 | summary: List Host Specifications | |
3559 | tags: | |
3560 | - Host | |
3561 | post: | |
3562 | parameters: [] | |
3563 | requestBody: | |
3564 | content: | |
3565 | application/json: | |
3566 | schema: | |
3567 | properties: | |
b3b6e05e TL |
3568 | addr: |
3569 | description: Network Address | |
3570 | type: string | |
f67539c2 | 3571 | hostname: |
b3b6e05e TL |
3572 | description: Hostname |
3573 | type: string | |
3574 | labels: | |
3575 | description: Host Labels | |
3576 | items: | |
3577 | type: string | |
3578 | type: array | |
3579 | status: | |
3580 | description: Host Status | |
f67539c2 TL |
3581 | type: string |
3582 | required: | |
3583 | - hostname | |
3584 | type: object | |
3585 | responses: | |
3586 | '201': | |
3587 | content: | |
b3b6e05e | 3588 | application/vnd.ceph.api.v0.1+json: |
f67539c2 TL |
3589 | type: object |
3590 | description: Resource created. | |
3591 | '202': | |
3592 | content: | |
b3b6e05e | 3593 | application/vnd.ceph.api.v0.1+json: |
f67539c2 TL |
3594 | type: object |
3595 | description: Operation is still executing. Please check the task queue. | |
3596 | '400': | |
3597 | description: Operation exception. Please check the response body for details. | |
3598 | '401': | |
3599 | description: Unauthenticated access. Please login first. | |
3600 | '403': | |
3601 | description: Unauthorized access. Please check your permissions. | |
3602 | '500': | |
3603 | description: Unexpected error. Please check the response body for the stack | |
3604 | trace. | |
3605 | security: | |
3606 | - jwt: [] | |
3607 | tags: | |
3608 | - Host | |
3609 | /api/host/{hostname}: | |
3610 | delete: | |
3611 | parameters: | |
3612 | - in: path | |
3613 | name: hostname | |
3614 | required: true | |
3615 | schema: | |
3616 | type: string | |
3617 | responses: | |
3618 | '202': | |
3619 | content: | |
3620 | application/vnd.ceph.api.v1.0+json: | |
3621 | type: object | |
3622 | description: Operation is still executing. Please check the task queue. | |
3623 | '204': | |
3624 | content: | |
3625 | application/vnd.ceph.api.v1.0+json: | |
3626 | type: object | |
3627 | description: Resource deleted. | |
3628 | '400': | |
3629 | description: Operation exception. Please check the response body for details. | |
3630 | '401': | |
3631 | description: Unauthenticated access. Please login first. | |
3632 | '403': | |
3633 | description: Unauthorized access. Please check your permissions. | |
3634 | '500': | |
3635 | description: Unexpected error. Please check the response body for the stack | |
3636 | trace. | |
3637 | security: | |
3638 | - jwt: [] | |
3639 | tags: | |
3640 | - Host | |
3641 | get: | |
3642 | description: "\n Get the specified host.\n :raises: cherrypy.HTTPError:\ | |
3643 | \ If host not found.\n " | |
3644 | parameters: | |
3645 | - in: path | |
3646 | name: hostname | |
3647 | required: true | |
3648 | schema: | |
3649 | type: string | |
3650 | responses: | |
3651 | '200': | |
3652 | content: | |
3653 | application/vnd.ceph.api.v1.0+json: | |
3654 | type: object | |
3655 | description: OK | |
3656 | '400': | |
3657 | description: Operation exception. Please check the response body for details. | |
3658 | '401': | |
3659 | description: Unauthenticated access. Please login first. | |
3660 | '403': | |
3661 | description: Unauthorized access. Please check your permissions. | |
3662 | '500': | |
3663 | description: Unexpected error. Please check the response body for the stack | |
3664 | trace. | |
3665 | security: | |
3666 | - jwt: [] | |
3667 | tags: | |
3668 | - Host | |
3669 | put: | |
3670 | description: "\n Update the specified host.\n Note, this is only\ | |
3671 | \ supported when Ceph Orchestrator is enabled.\n :param hostname: The\ | |
3672 | \ name of the host to be processed.\n :param update_labels: To update\ | |
3673 | \ the labels.\n :param labels: List of labels.\n :param maintenance:\ | |
3674 | \ Enter/Exit maintenance mode.\n :param force: Force enter maintenance\ | |
20effc67 | 3675 | \ mode.\n :param drain: Drain host\n " |
f67539c2 TL |
3676 | parameters: |
3677 | - description: Hostname | |
3678 | in: path | |
3679 | name: hostname | |
3680 | required: true | |
3681 | schema: | |
3682 | type: string | |
3683 | requestBody: | |
3684 | content: | |
3685 | application/json: | |
3686 | schema: | |
3687 | properties: | |
20effc67 TL |
3688 | drain: |
3689 | default: false | |
3690 | description: Drain Host | |
3691 | type: boolean | |
f67539c2 TL |
3692 | force: |
3693 | default: false | |
3694 | description: Force Enter Maintenance | |
3695 | type: boolean | |
3696 | labels: | |
3697 | description: Host Labels | |
3698 | items: | |
3699 | type: string | |
3700 | type: array | |
3701 | maintenance: | |
3702 | default: false | |
3703 | description: Enter/Exit Maintenance | |
3704 | type: boolean | |
3705 | update_labels: | |
3706 | default: false | |
3707 | description: Update Labels | |
3708 | type: boolean | |
3709 | type: object | |
3710 | responses: | |
3711 | '200': | |
3712 | content: | |
b3b6e05e | 3713 | application/vnd.ceph.api.v0.1+json: |
f67539c2 TL |
3714 | schema: |
3715 | properties: {} | |
3716 | type: object | |
3717 | description: Resource updated. | |
3718 | '202': | |
3719 | content: | |
b3b6e05e | 3720 | application/vnd.ceph.api.v0.1+json: |
f67539c2 TL |
3721 | type: object |
3722 | description: Operation is still executing. Please check the task queue. | |
3723 | '400': | |
3724 | description: Operation exception. Please check the response body for details. | |
3725 | '401': | |
3726 | description: Unauthenticated access. Please login first. | |
3727 | '403': | |
3728 | description: Unauthorized access. Please check your permissions. | |
3729 | '500': | |
3730 | description: Unexpected error. Please check the response body for the stack | |
3731 | trace. | |
3732 | security: | |
3733 | - jwt: [] | |
3734 | tags: | |
3735 | - Host | |
3736 | /api/host/{hostname}/daemons: | |
3737 | get: | |
3738 | parameters: | |
3739 | - in: path | |
3740 | name: hostname | |
3741 | required: true | |
3742 | schema: | |
3743 | type: string | |
3744 | responses: | |
3745 | '200': | |
3746 | content: | |
3747 | application/vnd.ceph.api.v1.0+json: | |
3748 | type: object | |
3749 | description: OK | |
3750 | '400': | |
3751 | description: Operation exception. Please check the response body for details. | |
3752 | '401': | |
3753 | description: Unauthenticated access. Please login first. | |
3754 | '403': | |
3755 | description: Unauthorized access. Please check your permissions. | |
3756 | '500': | |
3757 | description: Unexpected error. Please check the response body for the stack | |
3758 | trace. | |
3759 | security: | |
3760 | - jwt: [] | |
3761 | tags: | |
3762 | - Host | |
3763 | /api/host/{hostname}/devices: | |
3764 | get: | |
3765 | parameters: | |
3766 | - in: path | |
3767 | name: hostname | |
3768 | required: true | |
3769 | schema: | |
3770 | type: string | |
3771 | responses: | |
3772 | '200': | |
3773 | content: | |
3774 | application/vnd.ceph.api.v1.0+json: | |
3775 | type: object | |
3776 | description: OK | |
3777 | '400': | |
3778 | description: Operation exception. Please check the response body for details. | |
3779 | '401': | |
3780 | description: Unauthenticated access. Please login first. | |
3781 | '403': | |
3782 | description: Unauthorized access. Please check your permissions. | |
3783 | '500': | |
3784 | description: Unexpected error. Please check the response body for the stack | |
3785 | trace. | |
3786 | security: | |
3787 | - jwt: [] | |
3788 | tags: | |
3789 | - Host | |
3790 | /api/host/{hostname}/identify_device: | |
3791 | post: | |
3792 | description: "\n Identify a device by switching on the device light for\ | |
3793 | \ N seconds.\n :param hostname: The hostname of the device to process.\n\ | |
3794 | \ :param device: The device identifier to process, e.g. ``/dev/dm-0``\ | |
3795 | \ or\n ``ABC1234DEF567-1R1234_ABC8DE0Q``.\n :param duration:\ | |
3796 | \ The duration in seconds how long the LED should flash.\n " | |
3797 | parameters: | |
3798 | - in: path | |
3799 | name: hostname | |
3800 | required: true | |
3801 | schema: | |
3802 | type: string | |
3803 | requestBody: | |
3804 | content: | |
3805 | application/json: | |
3806 | schema: | |
3807 | properties: | |
3808 | device: | |
3809 | type: string | |
3810 | duration: | |
3811 | type: string | |
3812 | required: | |
3813 | - device | |
3814 | - duration | |
3815 | type: object | |
3816 | responses: | |
3817 | '201': | |
3818 | content: | |
3819 | application/vnd.ceph.api.v1.0+json: | |
3820 | type: object | |
3821 | description: Resource created. | |
3822 | '202': | |
3823 | content: | |
3824 | application/vnd.ceph.api.v1.0+json: | |
3825 | type: object | |
3826 | description: Operation is still executing. Please check the task queue. | |
3827 | '400': | |
3828 | description: Operation exception. Please check the response body for details. | |
3829 | '401': | |
3830 | description: Unauthenticated access. Please login first. | |
3831 | '403': | |
3832 | description: Unauthorized access. Please check your permissions. | |
3833 | '500': | |
3834 | description: Unexpected error. Please check the response body for the stack | |
3835 | trace. | |
3836 | security: | |
3837 | - jwt: [] | |
3838 | tags: | |
3839 | - Host | |
3840 | /api/host/{hostname}/inventory: | |
3841 | get: | |
3842 | parameters: | |
3843 | - description: Hostname | |
3844 | in: path | |
3845 | name: hostname | |
3846 | required: true | |
3847 | schema: | |
3848 | type: string | |
3849 | - allowEmptyValue: true | |
3850 | description: Trigger asynchronous refresh | |
3851 | in: query | |
3852 | name: refresh | |
3853 | schema: | |
3854 | type: string | |
3855 | responses: | |
3856 | '200': | |
3857 | content: | |
3858 | application/vnd.ceph.api.v1.0+json: | |
3859 | schema: | |
3860 | properties: | |
3861 | addr: | |
3862 | description: Host address | |
3863 | type: string | |
3864 | devices: | |
3865 | description: Host devices | |
3866 | items: | |
3867 | properties: | |
3868 | available: | |
3869 | description: If the device can be provisioned to an OSD | |
3870 | type: boolean | |
3871 | device_id: | |
3872 | description: Device's udev ID | |
3873 | type: string | |
3874 | human_readable_type: | |
3875 | description: Device type. ssd or hdd | |
3876 | type: string | |
3877 | lsm_data: | |
3878 | description: '' | |
3879 | properties: | |
3880 | errors: | |
3881 | description: '' | |
3882 | items: | |
3883 | type: string | |
3884 | type: array | |
3885 | health: | |
3886 | description: '' | |
3887 | type: string | |
3888 | ledSupport: | |
3889 | description: '' | |
3890 | properties: | |
3891 | FAILstatus: | |
3892 | description: '' | |
3893 | type: string | |
3894 | FAILsupport: | |
3895 | description: '' | |
3896 | type: string | |
3897 | IDENTstatus: | |
3898 | description: '' | |
3899 | type: string | |
3900 | IDENTsupport: | |
3901 | description: '' | |
3902 | type: string | |
3903 | required: | |
3904 | - IDENTsupport | |
3905 | - IDENTstatus | |
3906 | - FAILsupport | |
3907 | - FAILstatus | |
3908 | type: object | |
3909 | linkSpeed: | |
3910 | description: '' | |
3911 | type: string | |
3912 | mediaType: | |
3913 | description: '' | |
3914 | type: string | |
3915 | rpm: | |
3916 | description: '' | |
3917 | type: string | |
3918 | serialNum: | |
3919 | description: '' | |
3920 | type: string | |
3921 | transport: | |
3922 | description: '' | |
3923 | type: string | |
3924 | required: | |
3925 | - serialNum | |
3926 | - transport | |
3927 | - mediaType | |
3928 | - rpm | |
3929 | - linkSpeed | |
3930 | - health | |
3931 | - ledSupport | |
3932 | - errors | |
3933 | type: object | |
3934 | lvs: | |
3935 | description: '' | |
3936 | items: | |
3937 | properties: | |
3938 | block_uuid: | |
3939 | description: '' | |
3940 | type: string | |
3941 | cluster_fsid: | |
3942 | description: '' | |
3943 | type: string | |
3944 | cluster_name: | |
3945 | description: '' | |
3946 | type: string | |
3947 | name: | |
3948 | description: '' | |
3949 | type: string | |
3950 | osd_fsid: | |
3951 | description: '' | |
3952 | type: string | |
3953 | osd_id: | |
3954 | description: '' | |
3955 | type: string | |
3956 | osdspec_affinity: | |
3957 | description: '' | |
3958 | type: string | |
3959 | type: | |
3960 | description: '' | |
3961 | type: string | |
3962 | required: | |
3963 | - name | |
3964 | - osd_id | |
3965 | - cluster_name | |
3966 | - type | |
3967 | - osd_fsid | |
3968 | - cluster_fsid | |
3969 | - osdspec_affinity | |
3970 | - block_uuid | |
3971 | type: object | |
3972 | type: array | |
3973 | osd_ids: | |
3974 | description: Device OSD IDs | |
3975 | items: | |
3976 | type: integer | |
3977 | type: array | |
3978 | path: | |
3979 | description: Device path | |
3980 | type: string | |
3981 | rejected_reasons: | |
3982 | description: '' | |
3983 | items: | |
3984 | type: string | |
3985 | type: array | |
3986 | sys_api: | |
3987 | description: '' | |
3988 | properties: | |
3989 | human_readable_size: | |
3990 | description: '' | |
3991 | type: string | |
3992 | locked: | |
3993 | description: '' | |
3994 | type: integer | |
3995 | model: | |
3996 | description: '' | |
3997 | type: string | |
3998 | nr_requests: | |
3999 | description: '' | |
4000 | type: string | |
4001 | partitions: | |
4002 | description: '' | |
4003 | properties: | |
4004 | partition_name: | |
4005 | description: '' | |
4006 | properties: | |
4007 | holders: | |
4008 | description: '' | |
4009 | items: | |
4010 | type: string | |
4011 | type: array | |
4012 | human_readable_size: | |
4013 | description: '' | |
4014 | type: string | |
4015 | sectors: | |
4016 | description: '' | |
4017 | type: string | |
4018 | sectorsize: | |
4019 | description: '' | |
4020 | type: integer | |
4021 | size: | |
4022 | description: '' | |
4023 | type: integer | |
4024 | start: | |
4025 | description: '' | |
4026 | type: string | |
4027 | required: | |
4028 | - start | |
4029 | - sectors | |
4030 | - sectorsize | |
4031 | - size | |
4032 | - human_readable_size | |
4033 | - holders | |
4034 | type: object | |
4035 | required: | |
4036 | - partition_name | |
4037 | type: object | |
4038 | path: | |
4039 | description: '' | |
4040 | type: string | |
4041 | removable: | |
4042 | description: '' | |
4043 | type: string | |
4044 | rev: | |
4045 | description: '' | |
4046 | type: string | |
4047 | ro: | |
4048 | description: '' | |
4049 | type: string | |
4050 | rotational: | |
4051 | description: '' | |
4052 | type: string | |
4053 | sas_address: | |
4054 | description: '' | |
4055 | type: string | |
4056 | sas_device_handle: | |
4057 | description: '' | |
4058 | type: string | |
4059 | scheduler_mode: | |
4060 | description: '' | |
4061 | type: string | |
4062 | sectors: | |
4063 | description: '' | |
4064 | type: integer | |
4065 | sectorsize: | |
4066 | description: '' | |
4067 | type: string | |
4068 | size: | |
4069 | description: '' | |
4070 | type: integer | |
4071 | support_discard: | |
4072 | description: '' | |
4073 | type: string | |
4074 | vendor: | |
4075 | description: '' | |
4076 | type: string | |
4077 | required: | |
4078 | - removable | |
4079 | - ro | |
4080 | - vendor | |
4081 | - model | |
4082 | - rev | |
4083 | - sas_address | |
4084 | - sas_device_handle | |
4085 | - support_discard | |
4086 | - rotational | |
4087 | - nr_requests | |
4088 | - scheduler_mode | |
4089 | - partitions | |
4090 | - sectors | |
4091 | - sectorsize | |
4092 | - size | |
4093 | - human_readable_size | |
4094 | - path | |
4095 | - locked | |
4096 | type: object | |
4097 | required: | |
4098 | - rejected_reasons | |
4099 | - available | |
4100 | - path | |
4101 | - sys_api | |
4102 | - lvs | |
4103 | - human_readable_type | |
4104 | - device_id | |
4105 | - lsm_data | |
4106 | - osd_ids | |
4107 | type: object | |
4108 | type: array | |
4109 | labels: | |
4110 | description: Host labels | |
4111 | items: | |
4112 | type: string | |
4113 | type: array | |
4114 | name: | |
4115 | description: Hostname | |
4116 | type: string | |
4117 | required: | |
4118 | - name | |
4119 | - addr | |
4120 | - devices | |
4121 | - labels | |
4122 | type: object | |
4123 | description: OK | |
4124 | '400': | |
4125 | description: Operation exception. Please check the response body for details. | |
4126 | '401': | |
4127 | description: Unauthenticated access. Please login first. | |
4128 | '403': | |
4129 | description: Unauthorized access. Please check your permissions. | |
4130 | '500': | |
4131 | description: Unexpected error. Please check the response body for the stack | |
4132 | trace. | |
4133 | security: | |
4134 | - jwt: [] | |
4135 | summary: Get inventory of a host | |
4136 | tags: | |
4137 | - Host | |
4138 | /api/host/{hostname}/smart: | |
4139 | get: | |
4140 | parameters: | |
4141 | - in: path | |
4142 | name: hostname | |
4143 | required: true | |
4144 | schema: | |
4145 | type: string | |
4146 | responses: | |
4147 | '200': | |
4148 | content: | |
4149 | application/vnd.ceph.api.v1.0+json: | |
4150 | type: object | |
4151 | description: OK | |
4152 | '400': | |
4153 | description: Operation exception. Please check the response body for details. | |
4154 | '401': | |
4155 | description: Unauthenticated access. Please login first. | |
4156 | '403': | |
4157 | description: Unauthorized access. Please check your permissions. | |
4158 | '500': | |
4159 | description: Unexpected error. Please check the response body for the stack | |
4160 | trace. | |
4161 | security: | |
4162 | - jwt: [] | |
4163 | tags: | |
4164 | - Host | |
4165 | /api/iscsi/discoveryauth: | |
4166 | get: | |
4167 | parameters: [] | |
4168 | responses: | |
4169 | '200': | |
4170 | content: | |
4171 | application/vnd.ceph.api.v1.0+json: | |
4172 | schema: | |
4173 | items: | |
4174 | properties: | |
4175 | mutual_password: | |
4176 | description: '' | |
4177 | type: string | |
4178 | mutual_user: | |
4179 | description: '' | |
4180 | type: string | |
4181 | password: | |
4182 | description: password | |
4183 | type: string | |
4184 | user: | |
4185 | description: username | |
4186 | type: string | |
4187 | type: object | |
4188 | required: | |
4189 | - user | |
4190 | - password | |
4191 | - mutual_user | |
4192 | - mutual_password | |
4193 | type: array | |
4194 | description: OK | |
4195 | '400': | |
4196 | description: Operation exception. Please check the response body for details. | |
4197 | '401': | |
4198 | description: Unauthenticated access. Please login first. | |
4199 | '403': | |
4200 | description: Unauthorized access. Please check your permissions. | |
4201 | '500': | |
4202 | description: Unexpected error. Please check the response body for the stack | |
4203 | trace. | |
4204 | security: | |
4205 | - jwt: [] | |
4206 | summary: Get Iscsi discoveryauth Details | |
4207 | tags: | |
4208 | - Iscsi | |
4209 | put: | |
4210 | parameters: | |
4211 | - description: Username | |
4212 | in: query | |
4213 | name: user | |
4214 | required: true | |
4215 | schema: | |
4216 | type: string | |
4217 | - description: Password | |
4218 | in: query | |
4219 | name: password | |
4220 | required: true | |
4221 | schema: | |
4222 | type: string | |
4223 | - description: Mutual UserName | |
4224 | in: query | |
4225 | name: mutual_user | |
4226 | required: true | |
4227 | schema: | |
4228 | type: string | |
4229 | - description: Mutual Password | |
4230 | in: query | |
4231 | name: mutual_password | |
4232 | required: true | |
4233 | schema: | |
4234 | type: string | |
4235 | requestBody: | |
4236 | content: | |
4237 | application/json: | |
4238 | schema: | |
4239 | properties: | |
4240 | mutual_password: | |
4241 | description: Mutual Password | |
4242 | type: string | |
4243 | mutual_user: | |
4244 | description: Mutual UserName | |
4245 | type: string | |
4246 | password: | |
4247 | description: Password | |
4248 | type: string | |
4249 | user: | |
4250 | description: Username | |
4251 | type: string | |
4252 | required: | |
4253 | - user | |
4254 | - password | |
4255 | - mutual_user | |
4256 | - mutual_password | |
4257 | type: object | |
4258 | responses: | |
4259 | '200': | |
4260 | content: | |
4261 | application/vnd.ceph.api.v1.0+json: | |
4262 | type: object | |
4263 | description: Resource updated. | |
4264 | '202': | |
4265 | content: | |
4266 | application/vnd.ceph.api.v1.0+json: | |
4267 | type: object | |
4268 | description: Operation is still executing. Please check the task queue. | |
4269 | '400': | |
4270 | description: Operation exception. Please check the response body for details. | |
4271 | '401': | |
4272 | description: Unauthenticated access. Please login first. | |
4273 | '403': | |
4274 | description: Unauthorized access. Please check your permissions. | |
4275 | '500': | |
4276 | description: Unexpected error. Please check the response body for the stack | |
4277 | trace. | |
4278 | security: | |
4279 | - jwt: [] | |
4280 | summary: Set Iscsi discoveryauth | |
4281 | tags: | |
4282 | - Iscsi | |
4283 | /api/iscsi/target: | |
4284 | get: | |
4285 | parameters: [] | |
4286 | responses: | |
4287 | '200': | |
4288 | content: | |
4289 | application/vnd.ceph.api.v1.0+json: | |
4290 | type: object | |
4291 | description: OK | |
4292 | '400': | |
4293 | description: Operation exception. Please check the response body for details. | |
4294 | '401': | |
4295 | description: Unauthenticated access. Please login first. | |
4296 | '403': | |
4297 | description: Unauthorized access. Please check your permissions. | |
4298 | '500': | |
4299 | description: Unexpected error. Please check the response body for the stack | |
4300 | trace. | |
4301 | security: | |
4302 | - jwt: [] | |
4303 | tags: | |
4304 | - IscsiTarget | |
4305 | post: | |
4306 | parameters: [] | |
4307 | requestBody: | |
4308 | content: | |
4309 | application/json: | |
4310 | schema: | |
4311 | properties: | |
4312 | acl_enabled: | |
4313 | type: string | |
4314 | auth: | |
4315 | type: string | |
4316 | clients: | |
4317 | type: string | |
4318 | disks: | |
4319 | type: string | |
4320 | groups: | |
4321 | type: string | |
4322 | portals: | |
4323 | type: string | |
4324 | target_controls: | |
4325 | type: string | |
4326 | target_iqn: | |
4327 | type: string | |
4328 | type: object | |
4329 | responses: | |
4330 | '201': | |
4331 | content: | |
4332 | application/vnd.ceph.api.v1.0+json: | |
4333 | type: object | |
4334 | description: Resource created. | |
4335 | '202': | |
4336 | content: | |
4337 | application/vnd.ceph.api.v1.0+json: | |
4338 | type: object | |
4339 | description: Operation is still executing. Please check the task queue. | |
4340 | '400': | |
4341 | description: Operation exception. Please check the response body for details. | |
4342 | '401': | |
4343 | description: Unauthenticated access. Please login first. | |
4344 | '403': | |
4345 | description: Unauthorized access. Please check your permissions. | |
4346 | '500': | |
4347 | description: Unexpected error. Please check the response body for the stack | |
4348 | trace. | |
4349 | security: | |
4350 | - jwt: [] | |
4351 | tags: | |
4352 | - IscsiTarget | |
4353 | /api/iscsi/target/{target_iqn}: | |
4354 | delete: | |
4355 | parameters: | |
4356 | - in: path | |
4357 | name: target_iqn | |
4358 | required: true | |
4359 | schema: | |
4360 | type: string | |
4361 | responses: | |
4362 | '202': | |
4363 | content: | |
4364 | application/vnd.ceph.api.v1.0+json: | |
4365 | type: object | |
4366 | description: Operation is still executing. Please check the task queue. | |
4367 | '204': | |
4368 | content: | |
4369 | application/vnd.ceph.api.v1.0+json: | |
4370 | type: object | |
4371 | description: Resource deleted. | |
4372 | '400': | |
4373 | description: Operation exception. Please check the response body for details. | |
4374 | '401': | |
4375 | description: Unauthenticated access. Please login first. | |
4376 | '403': | |
4377 | description: Unauthorized access. Please check your permissions. | |
4378 | '500': | |
4379 | description: Unexpected error. Please check the response body for the stack | |
4380 | trace. | |
4381 | security: | |
4382 | - jwt: [] | |
4383 | tags: | |
4384 | - IscsiTarget | |
4385 | get: | |
4386 | parameters: | |
4387 | - in: path | |
4388 | name: target_iqn | |
4389 | required: true | |
4390 | schema: | |
4391 | type: string | |
4392 | responses: | |
4393 | '200': | |
4394 | content: | |
4395 | application/vnd.ceph.api.v1.0+json: | |
4396 | type: object | |
4397 | description: OK | |
4398 | '400': | |
4399 | description: Operation exception. Please check the response body for details. | |
4400 | '401': | |
4401 | description: Unauthenticated access. Please login first. | |
4402 | '403': | |
4403 | description: Unauthorized access. Please check your permissions. | |
4404 | '500': | |
4405 | description: Unexpected error. Please check the response body for the stack | |
4406 | trace. | |
4407 | security: | |
4408 | - jwt: [] | |
4409 | tags: | |
4410 | - IscsiTarget | |
4411 | put: | |
4412 | parameters: | |
4413 | - in: path | |
4414 | name: target_iqn | |
4415 | required: true | |
4416 | schema: | |
4417 | type: string | |
4418 | requestBody: | |
4419 | content: | |
4420 | application/json: | |
4421 | schema: | |
4422 | properties: | |
4423 | acl_enabled: | |
4424 | type: string | |
4425 | auth: | |
4426 | type: string | |
4427 | clients: | |
4428 | type: string | |
4429 | disks: | |
4430 | type: string | |
4431 | groups: | |
4432 | type: string | |
4433 | new_target_iqn: | |
4434 | type: string | |
4435 | portals: | |
4436 | type: string | |
4437 | target_controls: | |
4438 | type: string | |
4439 | type: object | |
4440 | responses: | |
4441 | '200': | |
4442 | content: | |
4443 | application/vnd.ceph.api.v1.0+json: | |
4444 | type: object | |
4445 | description: Resource updated. | |
4446 | '202': | |
4447 | content: | |
4448 | application/vnd.ceph.api.v1.0+json: | |
4449 | type: object | |
4450 | description: Operation is still executing. Please check the task queue. | |
4451 | '400': | |
4452 | description: Operation exception. Please check the response body for details. | |
4453 | '401': | |
4454 | description: Unauthenticated access. Please login first. | |
4455 | '403': | |
4456 | description: Unauthorized access. Please check your permissions. | |
4457 | '500': | |
4458 | description: Unexpected error. Please check the response body for the stack | |
4459 | trace. | |
4460 | security: | |
4461 | - jwt: [] | |
4462 | tags: | |
4463 | - IscsiTarget | |
4464 | /api/logs/all: | |
4465 | get: | |
4466 | parameters: [] | |
4467 | responses: | |
4468 | '200': | |
4469 | content: | |
4470 | application/vnd.ceph.api.v1.0+json: | |
4471 | schema: | |
4472 | properties: | |
4473 | audit_log: | |
4474 | description: Audit log | |
4475 | items: | |
4476 | properties: | |
4477 | addrs: | |
4478 | description: '' | |
4479 | properties: | |
4480 | addrvec: | |
4481 | description: '' | |
4482 | items: | |
4483 | properties: | |
4484 | addr: | |
4485 | description: IP Address | |
4486 | type: string | |
4487 | nonce: | |
4488 | description: '' | |
4489 | type: integer | |
4490 | type: | |
4491 | description: '' | |
4492 | type: string | |
4493 | required: | |
4494 | - type | |
4495 | - addr | |
4496 | - nonce | |
4497 | type: object | |
4498 | type: array | |
4499 | required: | |
4500 | - addrvec | |
4501 | type: object | |
4502 | channel: | |
4503 | description: '' | |
4504 | type: string | |
4505 | message: | |
4506 | description: '' | |
4507 | type: string | |
4508 | name: | |
4509 | description: '' | |
4510 | type: string | |
4511 | priority: | |
4512 | description: '' | |
4513 | type: string | |
4514 | rank: | |
4515 | description: '' | |
4516 | type: string | |
4517 | seq: | |
4518 | description: '' | |
4519 | type: integer | |
4520 | stamp: | |
4521 | description: '' | |
4522 | type: string | |
4523 | required: | |
4524 | - name | |
4525 | - rank | |
4526 | - addrs | |
4527 | - stamp | |
4528 | - seq | |
4529 | - channel | |
4530 | - priority | |
4531 | - message | |
4532 | type: object | |
4533 | type: array | |
4534 | clog: | |
4535 | description: '' | |
4536 | items: | |
4537 | type: string | |
4538 | type: array | |
4539 | required: | |
4540 | - clog | |
4541 | - audit_log | |
4542 | type: object | |
4543 | description: OK | |
4544 | '400': | |
4545 | description: Operation exception. Please check the response body for details. | |
4546 | '401': | |
4547 | description: Unauthenticated access. Please login first. | |
4548 | '403': | |
4549 | description: Unauthorized access. Please check your permissions. | |
4550 | '500': | |
4551 | description: Unexpected error. Please check the response body for the stack | |
4552 | trace. | |
4553 | security: | |
4554 | - jwt: [] | |
4555 | summary: Display Logs Configuration | |
4556 | tags: | |
4557 | - Logs | |
4558 | /api/mgr/module: | |
4559 | get: | |
4560 | description: "\n Get the list of managed modules.\n :return: A\ | |
4561 | \ list of objects with the fields 'enabled', 'name' and 'options'.\n \ | |
4562 | \ :rtype: list\n " | |
4563 | parameters: [] | |
4564 | responses: | |
4565 | '200': | |
4566 | content: | |
4567 | application/vnd.ceph.api.v1.0+json: | |
4568 | schema: | |
4569 | items: | |
4570 | properties: | |
4571 | always_on: | |
4572 | description: Is it an always on module? | |
4573 | type: boolean | |
4574 | enabled: | |
4575 | description: Is Module Enabled | |
4576 | type: boolean | |
4577 | name: | |
4578 | description: Module Name | |
4579 | type: string | |
4580 | options: | |
4581 | description: Module Options | |
4582 | properties: | |
4583 | Option_name: | |
4584 | description: Options | |
4585 | properties: | |
4586 | default_value: | |
4587 | description: Default value for the option | |
4588 | type: integer | |
4589 | desc: | |
4590 | description: Description of the option | |
4591 | type: string | |
4592 | enum_allowed: | |
4593 | description: '' | |
4594 | items: | |
4595 | type: string | |
4596 | type: array | |
4597 | flags: | |
4598 | description: List of flags associated | |
4599 | type: integer | |
4600 | level: | |
4601 | description: Option level | |
4602 | type: string | |
4603 | long_desc: | |
4604 | description: Elaborated description | |
4605 | type: string | |
4606 | max: | |
4607 | description: Maximum value | |
4608 | type: string | |
4609 | min: | |
4610 | description: Minimum value | |
4611 | type: string | |
4612 | name: | |
4613 | description: Name of the option | |
4614 | type: string | |
4615 | see_also: | |
4616 | description: Related options | |
4617 | items: | |
4618 | type: string | |
4619 | type: array | |
4620 | tags: | |
4621 | description: Tags associated with the option | |
4622 | items: | |
4623 | type: string | |
4624 | type: array | |
4625 | type: | |
4626 | description: Type of the option | |
4627 | type: string | |
4628 | required: | |
4629 | - name | |
4630 | - type | |
4631 | - level | |
4632 | - flags | |
4633 | - default_value | |
4634 | - min | |
4635 | - max | |
4636 | - enum_allowed | |
4637 | - desc | |
4638 | - long_desc | |
4639 | - tags | |
4640 | - see_also | |
4641 | type: object | |
4642 | required: | |
4643 | - Option_name | |
4644 | type: object | |
4645 | type: object | |
4646 | required: | |
4647 | - name | |
4648 | - enabled | |
4649 | - always_on | |
4650 | - options | |
4651 | type: array | |
4652 | description: OK | |
4653 | '400': | |
4654 | description: Operation exception. Please check the response body for details. | |
4655 | '401': | |
4656 | description: Unauthenticated access. Please login first. | |
4657 | '403': | |
4658 | description: Unauthorized access. Please check your permissions. | |
4659 | '500': | |
4660 | description: Unexpected error. Please check the response body for the stack | |
4661 | trace. | |
4662 | security: | |
4663 | - jwt: [] | |
4664 | summary: List Mgr modules | |
4665 | tags: | |
4666 | - MgrModule | |
4667 | /api/mgr/module/{module_name}: | |
4668 | get: | |
4669 | description: "\n Retrieve the values of the persistent configuration\ | |
4670 | \ settings.\n :param module_name: The name of the Ceph Mgr module.\n\ | |
4671 | \ :type module_name: str\n :return: The values of the module\ | |
4672 | \ options.\n :rtype: dict\n " | |
4673 | parameters: | |
4674 | - in: path | |
4675 | name: module_name | |
4676 | required: true | |
4677 | schema: | |
4678 | type: string | |
4679 | responses: | |
4680 | '200': | |
4681 | content: | |
4682 | application/vnd.ceph.api.v1.0+json: | |
4683 | type: object | |
4684 | description: OK | |
4685 | '400': | |
4686 | description: Operation exception. Please check the response body for details. | |
4687 | '401': | |
4688 | description: Unauthenticated access. Please login first. | |
4689 | '403': | |
4690 | description: Unauthorized access. Please check your permissions. | |
4691 | '500': | |
4692 | description: Unexpected error. Please check the response body for the stack | |
4693 | trace. | |
4694 | security: | |
4695 | - jwt: [] | |
4696 | tags: | |
4697 | - MgrModule | |
4698 | put: | |
4699 | description: "\n Set the values of the persistent configuration settings.\n\ | |
4700 | \ :param module_name: The name of the Ceph Mgr module.\n :type\ | |
4701 | \ module_name: str\n :param config: The values of the module options\ | |
4702 | \ to be stored.\n :type config: dict\n " | |
4703 | parameters: | |
4704 | - in: path | |
4705 | name: module_name | |
4706 | required: true | |
4707 | schema: | |
4708 | type: string | |
4709 | requestBody: | |
4710 | content: | |
4711 | application/json: | |
4712 | schema: | |
4713 | properties: | |
4714 | config: | |
4715 | type: string | |
4716 | required: | |
4717 | - config | |
4718 | type: object | |
4719 | responses: | |
4720 | '200': | |
4721 | content: | |
4722 | application/vnd.ceph.api.v1.0+json: | |
4723 | type: object | |
4724 | description: Resource updated. | |
4725 | '202': | |
4726 | content: | |
4727 | application/vnd.ceph.api.v1.0+json: | |
4728 | type: object | |
4729 | description: Operation is still executing. Please check the task queue. | |
4730 | '400': | |
4731 | description: Operation exception. Please check the response body for details. | |
4732 | '401': | |
4733 | description: Unauthenticated access. Please login first. | |
4734 | '403': | |
4735 | description: Unauthorized access. Please check your permissions. | |
4736 | '500': | |
4737 | description: Unexpected error. Please check the response body for the stack | |
4738 | trace. | |
4739 | security: | |
4740 | - jwt: [] | |
4741 | tags: | |
4742 | - MgrModule | |
4743 | /api/mgr/module/{module_name}/disable: | |
4744 | post: | |
4745 | description: "\n Disable the specified Ceph Mgr module.\n :param\ | |
4746 | \ module_name: The name of the Ceph Mgr module.\n :type module_name:\ | |
4747 | \ str\n " | |
4748 | parameters: | |
4749 | - in: path | |
4750 | name: module_name | |
4751 | required: true | |
4752 | schema: | |
4753 | type: string | |
4754 | responses: | |
4755 | '201': | |
4756 | content: | |
4757 | application/vnd.ceph.api.v1.0+json: | |
4758 | type: object | |
4759 | description: Resource created. | |
4760 | '202': | |
4761 | content: | |
4762 | application/vnd.ceph.api.v1.0+json: | |
4763 | type: object | |
4764 | description: Operation is still executing. Please check the task queue. | |
4765 | '400': | |
4766 | description: Operation exception. Please check the response body for details. | |
4767 | '401': | |
4768 | description: Unauthenticated access. Please login first. | |
4769 | '403': | |
4770 | description: Unauthorized access. Please check your permissions. | |
4771 | '500': | |
4772 | description: Unexpected error. Please check the response body for the stack | |
4773 | trace. | |
4774 | security: | |
4775 | - jwt: [] | |
4776 | tags: | |
4777 | - MgrModule | |
4778 | /api/mgr/module/{module_name}/enable: | |
4779 | post: | |
4780 | description: "\n Enable the specified Ceph Mgr module.\n :param\ | |
4781 | \ module_name: The name of the Ceph Mgr module.\n :type module_name:\ | |
4782 | \ str\n " | |
4783 | parameters: | |
4784 | - in: path | |
4785 | name: module_name | |
4786 | required: true | |
4787 | schema: | |
4788 | type: string | |
4789 | responses: | |
4790 | '201': | |
4791 | content: | |
4792 | application/vnd.ceph.api.v1.0+json: | |
4793 | type: object | |
4794 | description: Resource created. | |
4795 | '202': | |
4796 | content: | |
4797 | application/vnd.ceph.api.v1.0+json: | |
4798 | type: object | |
4799 | description: Operation is still executing. Please check the task queue. | |
4800 | '400': | |
4801 | description: Operation exception. Please check the response body for details. | |
4802 | '401': | |
4803 | description: Unauthenticated access. Please login first. | |
4804 | '403': | |
4805 | description: Unauthorized access. Please check your permissions. | |
4806 | '500': | |
4807 | description: Unexpected error. Please check the response body for the stack | |
4808 | trace. | |
4809 | security: | |
4810 | - jwt: [] | |
4811 | tags: | |
4812 | - MgrModule | |
4813 | /api/mgr/module/{module_name}/options: | |
4814 | get: | |
4815 | description: "\n Get the module options of the specified Ceph Mgr module.\n\ | |
4816 | \ :param module_name: The name of the Ceph Mgr module.\n :type\ | |
4817 | \ module_name: str\n :return: The module options as list of dicts.\n\ | |
4818 | \ :rtype: list\n " | |
4819 | parameters: | |
4820 | - in: path | |
4821 | name: module_name | |
4822 | required: true | |
4823 | schema: | |
4824 | type: string | |
4825 | responses: | |
4826 | '200': | |
4827 | content: | |
4828 | application/vnd.ceph.api.v1.0+json: | |
4829 | type: object | |
4830 | description: OK | |
4831 | '400': | |
4832 | description: Operation exception. Please check the response body for details. | |
4833 | '401': | |
4834 | description: Unauthenticated access. Please login first. | |
4835 | '403': | |
4836 | description: Unauthorized access. Please check your permissions. | |
4837 | '500': | |
4838 | description: Unexpected error. Please check the response body for the stack | |
4839 | trace. | |
4840 | security: | |
4841 | - jwt: [] | |
4842 | tags: | |
4843 | - MgrModule | |
4844 | /api/monitor: | |
4845 | get: | |
4846 | parameters: [] | |
4847 | responses: | |
4848 | '200': | |
4849 | content: | |
4850 | application/vnd.ceph.api.v1.0+json: | |
4851 | schema: | |
4852 | properties: | |
4853 | in_quorum: | |
4854 | description: '' | |
4855 | items: | |
4856 | properties: | |
4857 | addr: | |
4858 | description: '' | |
4859 | type: string | |
4860 | name: | |
4861 | description: '' | |
4862 | type: string | |
4863 | priority: | |
4864 | description: '' | |
4865 | type: integer | |
4866 | public_addr: | |
4867 | description: '' | |
4868 | type: string | |
4869 | public_addrs: | |
4870 | description: '' | |
4871 | properties: | |
4872 | addrvec: | |
4873 | description: '' | |
4874 | items: | |
4875 | properties: | |
4876 | addr: | |
4877 | description: '' | |
4878 | type: string | |
4879 | nonce: | |
4880 | description: '' | |
4881 | type: integer | |
4882 | type: | |
4883 | description: '' | |
4884 | type: string | |
4885 | required: | |
4886 | - type | |
4887 | - addr | |
4888 | - nonce | |
4889 | type: object | |
4890 | type: array | |
4891 | required: | |
4892 | - addrvec | |
4893 | type: object | |
4894 | rank: | |
4895 | description: '' | |
4896 | type: integer | |
4897 | stats: | |
4898 | description: '' | |
4899 | properties: | |
4900 | num_sessions: | |
4901 | description: '' | |
4902 | items: | |
4903 | type: integer | |
4904 | type: array | |
4905 | required: | |
4906 | - num_sessions | |
4907 | type: object | |
4908 | weight: | |
4909 | description: '' | |
4910 | type: integer | |
4911 | required: | |
4912 | - rank | |
4913 | - name | |
4914 | - public_addrs | |
4915 | - addr | |
4916 | - public_addr | |
4917 | - priority | |
4918 | - weight | |
4919 | - stats | |
4920 | type: object | |
4921 | type: array | |
4922 | mon_status: | |
4923 | description: '' | |
4924 | properties: | |
4925 | election_epoch: | |
4926 | description: '' | |
4927 | type: integer | |
4928 | extra_probe_peers: | |
4929 | description: '' | |
4930 | items: | |
4931 | type: string | |
4932 | type: array | |
4933 | feature_map: | |
4934 | description: '' | |
4935 | properties: | |
4936 | client: | |
4937 | description: '' | |
4938 | items: | |
4939 | properties: | |
4940 | features: | |
4941 | description: '' | |
4942 | type: string | |
4943 | num: | |
4944 | description: '' | |
4945 | type: integer | |
4946 | release: | |
4947 | description: '' | |
4948 | type: string | |
4949 | required: | |
4950 | - features | |
4951 | - release | |
4952 | - num | |
4953 | type: object | |
4954 | type: array | |
4955 | mds: | |
4956 | description: '' | |
4957 | items: | |
4958 | properties: | |
4959 | features: | |
4960 | description: '' | |
4961 | type: string | |
4962 | num: | |
4963 | description: '' | |
4964 | type: integer | |
4965 | release: | |
4966 | description: '' | |
4967 | type: string | |
4968 | required: | |
4969 | - features | |
4970 | - release | |
4971 | - num | |
4972 | type: object | |
4973 | type: array | |
4974 | mgr: | |
4975 | description: '' | |
4976 | items: | |
4977 | properties: | |
4978 | features: | |
4979 | description: '' | |
4980 | type: string | |
4981 | num: | |
4982 | description: '' | |
4983 | type: integer | |
4984 | release: | |
4985 | description: '' | |
4986 | type: string | |
4987 | required: | |
4988 | - features | |
4989 | - release | |
4990 | - num | |
4991 | type: object | |
4992 | type: array | |
4993 | mon: | |
4994 | description: '' | |
4995 | items: | |
4996 | properties: | |
4997 | features: | |
4998 | description: '' | |
4999 | type: string | |
5000 | num: | |
5001 | description: '' | |
5002 | type: integer | |
5003 | release: | |
5004 | description: '' | |
5005 | type: string | |
5006 | required: | |
5007 | - features | |
5008 | - release | |
5009 | - num | |
5010 | type: object | |
5011 | type: array | |
5012 | required: | |
5013 | - mon | |
5014 | - mds | |
5015 | - client | |
5016 | - mgr | |
5017 | type: object | |
5018 | features: | |
5019 | description: '' | |
5020 | properties: | |
5021 | quorum_con: | |
5022 | description: '' | |
5023 | type: string | |
5024 | quorum_mon: | |
5025 | description: '' | |
5026 | items: | |
5027 | type: string | |
5028 | type: array | |
5029 | required_con: | |
5030 | description: '' | |
5031 | type: string | |
5032 | required_mon: | |
5033 | description: '' | |
5034 | items: | |
5035 | type: integer | |
5036 | type: array | |
5037 | required: | |
5038 | - required_con | |
5039 | - required_mon | |
5040 | - quorum_con | |
5041 | - quorum_mon | |
5042 | type: object | |
5043 | monmap: | |
5044 | description: '' | |
5045 | properties: | |
5046 | created: | |
5047 | description: '' | |
5048 | type: string | |
5049 | epoch: | |
5050 | description: '' | |
5051 | type: integer | |
5052 | features: | |
5053 | description: '' | |
5054 | properties: | |
5055 | optional: | |
5056 | description: '' | |
5057 | items: | |
5058 | type: string | |
5059 | type: array | |
5060 | persistent: | |
5061 | description: '' | |
5062 | items: | |
5063 | type: string | |
5064 | type: array | |
5065 | required: | |
5066 | - persistent | |
5067 | - optional | |
5068 | type: object | |
5069 | fsid: | |
5070 | description: '' | |
5071 | type: string | |
5072 | min_mon_release: | |
5073 | description: '' | |
5074 | type: integer | |
5075 | min_mon_release_name: | |
5076 | description: '' | |
5077 | type: string | |
5078 | modified: | |
5079 | description: '' | |
5080 | type: string | |
5081 | mons: | |
5082 | description: '' | |
5083 | items: | |
5084 | properties: | |
5085 | addr: | |
5086 | description: '' | |
5087 | type: string | |
5088 | name: | |
5089 | description: '' | |
5090 | type: string | |
5091 | priority: | |
5092 | description: '' | |
5093 | type: integer | |
5094 | public_addr: | |
5095 | description: '' | |
5096 | type: string | |
5097 | public_addrs: | |
5098 | description: '' | |
5099 | properties: | |
5100 | addrvec: | |
5101 | description: '' | |
5102 | items: | |
5103 | properties: | |
5104 | addr: | |
5105 | description: '' | |
5106 | type: string | |
5107 | nonce: | |
5108 | description: '' | |
5109 | type: integer | |
5110 | type: | |
5111 | description: '' | |
5112 | type: string | |
5113 | required: | |
5114 | - type | |
5115 | - addr | |
5116 | - nonce | |
5117 | type: object | |
5118 | type: array | |
5119 | required: | |
5120 | - addrvec | |
5121 | type: object | |
5122 | rank: | |
5123 | description: '' | |
5124 | type: integer | |
5125 | stats: | |
5126 | description: '' | |
5127 | properties: | |
5128 | num_sessions: | |
5129 | description: '' | |
5130 | items: | |
5131 | type: integer | |
5132 | type: array | |
5133 | required: | |
5134 | - num_sessions | |
5135 | type: object | |
5136 | weight: | |
5137 | description: '' | |
5138 | type: integer | |
5139 | required: | |
5140 | - rank | |
5141 | - name | |
5142 | - public_addrs | |
5143 | - addr | |
5144 | - public_addr | |
5145 | - priority | |
5146 | - weight | |
5147 | - stats | |
5148 | type: object | |
5149 | type: array | |
5150 | required: | |
5151 | - epoch | |
5152 | - fsid | |
5153 | - modified | |
5154 | - created | |
5155 | - min_mon_release | |
5156 | - min_mon_release_name | |
5157 | - features | |
5158 | - mons | |
5159 | type: object | |
5160 | name: | |
5161 | description: '' | |
5162 | type: string | |
5163 | outside_quorum: | |
5164 | description: '' | |
5165 | items: | |
5166 | type: string | |
5167 | type: array | |
5168 | quorum: | |
5169 | description: '' | |
5170 | items: | |
5171 | type: integer | |
5172 | type: array | |
5173 | quorum_age: | |
5174 | description: '' | |
5175 | type: integer | |
5176 | rank: | |
5177 | description: '' | |
5178 | type: integer | |
5179 | state: | |
5180 | description: '' | |
5181 | type: string | |
5182 | sync_provider: | |
5183 | description: '' | |
5184 | items: | |
5185 | type: string | |
5186 | type: array | |
5187 | required: | |
5188 | - name | |
5189 | - rank | |
5190 | - state | |
5191 | - election_epoch | |
5192 | - quorum | |
5193 | - quorum_age | |
5194 | - features | |
5195 | - outside_quorum | |
5196 | - extra_probe_peers | |
5197 | - sync_provider | |
5198 | - monmap | |
5199 | - feature_map | |
5200 | type: object | |
5201 | out_quorum: | |
5202 | description: '' | |
5203 | items: | |
5204 | type: integer | |
5205 | type: array | |
5206 | required: | |
5207 | - mon_status | |
5208 | - in_quorum | |
5209 | - out_quorum | |
5210 | type: object | |
5211 | description: OK | |
5212 | '400': | |
5213 | description: Operation exception. Please check the response body for details. | |
5214 | '401': | |
5215 | description: Unauthenticated access. Please login first. | |
5216 | '403': | |
5217 | description: Unauthorized access. Please check your permissions. | |
5218 | '500': | |
5219 | description: Unexpected error. Please check the response body for the stack | |
5220 | trace. | |
5221 | security: | |
5222 | - jwt: [] | |
5223 | summary: Get Monitor Details | |
5224 | tags: | |
5225 | - Monitor | |
a4b75251 | 5226 | /api/nfs-ganesha/cluster: |
f67539c2 TL |
5227 | get: |
5228 | parameters: [] | |
5229 | responses: | |
5230 | '200': | |
5231 | content: | |
a4b75251 TL |
5232 | application/vnd.ceph.api.v0.1+json: |
5233 | type: object | |
f67539c2 TL |
5234 | description: OK |
5235 | '400': | |
5236 | description: Operation exception. Please check the response body for details. | |
5237 | '401': | |
5238 | description: Unauthenticated access. Please login first. | |
5239 | '403': | |
5240 | description: Unauthorized access. Please check your permissions. | |
5241 | '500': | |
5242 | description: Unexpected error. Please check the response body for the stack | |
5243 | trace. | |
5244 | security: | |
5245 | - jwt: [] | |
f67539c2 TL |
5246 | tags: |
5247 | - NFS-Ganesha | |
5248 | /api/nfs-ganesha/export: | |
5249 | get: | |
5250 | parameters: [] | |
5251 | responses: | |
5252 | '200': | |
5253 | content: | |
5254 | application/vnd.ceph.api.v1.0+json: | |
5255 | schema: | |
5256 | items: | |
5257 | properties: | |
5258 | access_type: | |
5259 | description: Export access type | |
5260 | type: string | |
5261 | clients: | |
5262 | description: List of client configurations | |
5263 | items: | |
5264 | properties: | |
5265 | access_type: | |
5266 | description: Client access type | |
5267 | type: string | |
5268 | addresses: | |
5269 | description: list of IP addresses | |
5270 | items: | |
5271 | type: string | |
5272 | type: array | |
5273 | squash: | |
5274 | description: Client squash policy | |
5275 | type: string | |
5276 | required: | |
5277 | - addresses | |
5278 | - access_type | |
5279 | - squash | |
5280 | type: object | |
5281 | type: array | |
5282 | cluster_id: | |
5283 | description: Cluster identifier | |
5284 | type: string | |
f67539c2 TL |
5285 | export_id: |
5286 | description: Export ID | |
5287 | type: integer | |
5288 | fsal: | |
5289 | description: FSAL configuration | |
5290 | properties: | |
a4b75251 TL |
5291 | fs_name: |
5292 | description: CephFS filesystem name | |
f67539c2 TL |
5293 | type: string |
5294 | name: | |
5295 | description: name of FSAL | |
5296 | type: string | |
f67539c2 TL |
5297 | sec_label_xattr: |
5298 | description: Name of xattr for security label | |
5299 | type: string | |
5300 | user_id: | |
a4b75251 | 5301 | description: User id |
f67539c2 TL |
5302 | type: string |
5303 | required: | |
5304 | - name | |
5305 | type: object | |
5306 | path: | |
5307 | description: Export path | |
5308 | type: string | |
5309 | protocols: | |
5310 | description: List of protocol types | |
5311 | items: | |
5312 | type: integer | |
5313 | type: array | |
5314 | pseudo: | |
5315 | description: Pseudo FS path | |
5316 | type: string | |
5317 | security_label: | |
5318 | description: Security label | |
5319 | type: string | |
5320 | squash: | |
5321 | description: Export squash policy | |
5322 | type: string | |
f67539c2 TL |
5323 | transports: |
5324 | description: List of transport types | |
5325 | items: | |
5326 | type: string | |
5327 | type: array | |
5328 | type: object | |
5329 | required: | |
5330 | - export_id | |
5331 | - path | |
5332 | - cluster_id | |
f67539c2 | 5333 | - pseudo |
f67539c2 TL |
5334 | - access_type |
5335 | - squash | |
5336 | - security_label | |
5337 | - protocols | |
5338 | - transports | |
5339 | - fsal | |
5340 | - clients | |
5341 | type: array | |
5342 | description: OK | |
5343 | '400': | |
5344 | description: Operation exception. Please check the response body for details. | |
5345 | '401': | |
5346 | description: Unauthenticated access. Please login first. | |
5347 | '403': | |
5348 | description: Unauthorized access. Please check your permissions. | |
5349 | '500': | |
5350 | description: Unexpected error. Please check the response body for the stack | |
5351 | trace. | |
5352 | security: | |
5353 | - jwt: [] | |
5354 | summary: List all NFS-Ganesha exports | |
5355 | tags: | |
5356 | - NFS-Ganesha | |
5357 | post: | |
5358 | parameters: [] | |
5359 | requestBody: | |
5360 | content: | |
5361 | application/json: | |
5362 | schema: | |
5363 | properties: | |
5364 | access_type: | |
5365 | description: Export access type | |
5366 | type: string | |
5367 | clients: | |
5368 | description: List of client configurations | |
5369 | items: | |
5370 | properties: | |
5371 | access_type: | |
5372 | description: Client access type | |
5373 | type: string | |
5374 | addresses: | |
5375 | description: list of IP addresses | |
5376 | items: | |
5377 | type: string | |
5378 | type: array | |
5379 | squash: | |
5380 | description: Client squash policy | |
5381 | type: string | |
5382 | required: | |
5383 | - addresses | |
5384 | - access_type | |
5385 | - squash | |
5386 | type: object | |
5387 | type: array | |
5388 | cluster_id: | |
5389 | description: Cluster identifier | |
5390 | type: string | |
f67539c2 TL |
5391 | fsal: |
5392 | description: FSAL configuration | |
5393 | properties: | |
a4b75251 TL |
5394 | fs_name: |
5395 | description: CephFS filesystem name | |
f67539c2 TL |
5396 | type: string |
5397 | name: | |
5398 | description: name of FSAL | |
5399 | type: string | |
f67539c2 TL |
5400 | sec_label_xattr: |
5401 | description: Name of xattr for security label | |
5402 | type: string | |
f67539c2 TL |
5403 | required: |
5404 | - name | |
5405 | type: object | |
5406 | path: | |
5407 | description: Export path | |
5408 | type: string | |
5409 | protocols: | |
5410 | description: List of protocol types | |
5411 | items: | |
5412 | type: integer | |
5413 | type: array | |
5414 | pseudo: | |
5415 | description: Pseudo FS path | |
5416 | type: string | |
f67539c2 TL |
5417 | security_label: |
5418 | description: Security label | |
5419 | type: string | |
5420 | squash: | |
5421 | description: Export squash policy | |
5422 | type: string | |
f67539c2 TL |
5423 | transports: |
5424 | description: List of transport types | |
5425 | items: | |
5426 | type: string | |
5427 | type: array | |
5428 | required: | |
5429 | - path | |
5430 | - cluster_id | |
f67539c2 | 5431 | - pseudo |
f67539c2 TL |
5432 | - access_type |
5433 | - squash | |
5434 | - security_label | |
5435 | - protocols | |
5436 | - transports | |
5437 | - fsal | |
5438 | - clients | |
5439 | type: object | |
5440 | responses: | |
5441 | '201': | |
5442 | content: | |
a4b75251 | 5443 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5444 | schema: |
5445 | properties: | |
5446 | access_type: | |
5447 | description: Export access type | |
5448 | type: string | |
5449 | clients: | |
5450 | description: List of client configurations | |
5451 | items: | |
5452 | properties: | |
5453 | access_type: | |
5454 | description: Client access type | |
5455 | type: string | |
5456 | addresses: | |
5457 | description: list of IP addresses | |
5458 | items: | |
5459 | type: string | |
5460 | type: array | |
5461 | squash: | |
5462 | description: Client squash policy | |
5463 | type: string | |
5464 | required: | |
5465 | - addresses | |
5466 | - access_type | |
5467 | - squash | |
5468 | type: object | |
5469 | type: array | |
5470 | cluster_id: | |
5471 | description: Cluster identifier | |
5472 | type: string | |
f67539c2 TL |
5473 | export_id: |
5474 | description: Export ID | |
5475 | type: integer | |
5476 | fsal: | |
5477 | description: FSAL configuration | |
5478 | properties: | |
a4b75251 TL |
5479 | fs_name: |
5480 | description: CephFS filesystem name | |
f67539c2 TL |
5481 | type: string |
5482 | name: | |
5483 | description: name of FSAL | |
5484 | type: string | |
f67539c2 TL |
5485 | sec_label_xattr: |
5486 | description: Name of xattr for security label | |
5487 | type: string | |
5488 | user_id: | |
a4b75251 | 5489 | description: User id |
f67539c2 TL |
5490 | type: string |
5491 | required: | |
5492 | - name | |
5493 | type: object | |
5494 | path: | |
5495 | description: Export path | |
5496 | type: string | |
5497 | protocols: | |
5498 | description: List of protocol types | |
5499 | items: | |
5500 | type: integer | |
5501 | type: array | |
5502 | pseudo: | |
5503 | description: Pseudo FS path | |
5504 | type: string | |
5505 | security_label: | |
5506 | description: Security label | |
5507 | type: string | |
5508 | squash: | |
5509 | description: Export squash policy | |
5510 | type: string | |
f67539c2 TL |
5511 | transports: |
5512 | description: List of transport types | |
5513 | items: | |
5514 | type: string | |
5515 | type: array | |
5516 | required: | |
5517 | - export_id | |
5518 | - path | |
5519 | - cluster_id | |
f67539c2 | 5520 | - pseudo |
f67539c2 TL |
5521 | - access_type |
5522 | - squash | |
5523 | - security_label | |
5524 | - protocols | |
5525 | - transports | |
5526 | - fsal | |
5527 | - clients | |
5528 | type: object | |
5529 | description: Resource created. | |
5530 | '202': | |
5531 | content: | |
a4b75251 | 5532 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5533 | type: object |
5534 | description: Operation is still executing. Please check the task queue. | |
5535 | '400': | |
5536 | description: Operation exception. Please check the response body for details. | |
5537 | '401': | |
5538 | description: Unauthenticated access. Please login first. | |
5539 | '403': | |
5540 | description: Unauthorized access. Please check your permissions. | |
5541 | '500': | |
5542 | description: Unexpected error. Please check the response body for the stack | |
5543 | trace. | |
5544 | security: | |
5545 | - jwt: [] | |
5546 | summary: Creates a new NFS-Ganesha export | |
5547 | tags: | |
5548 | - NFS-Ganesha | |
5549 | /api/nfs-ganesha/export/{cluster_id}/{export_id}: | |
5550 | delete: | |
5551 | parameters: | |
5552 | - description: Cluster identifier | |
5553 | in: path | |
5554 | name: cluster_id | |
5555 | required: true | |
5556 | schema: | |
5557 | type: string | |
5558 | - description: Export ID | |
5559 | in: path | |
5560 | name: export_id | |
5561 | required: true | |
5562 | schema: | |
5563 | type: integer | |
f67539c2 TL |
5564 | responses: |
5565 | '202': | |
5566 | content: | |
a4b75251 | 5567 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5568 | type: object |
5569 | description: Operation is still executing. Please check the task queue. | |
5570 | '204': | |
5571 | content: | |
a4b75251 | 5572 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5573 | type: object |
5574 | description: Resource deleted. | |
5575 | '400': | |
5576 | description: Operation exception. Please check the response body for details. | |
5577 | '401': | |
5578 | description: Unauthenticated access. Please login first. | |
5579 | '403': | |
5580 | description: Unauthorized access. Please check your permissions. | |
5581 | '500': | |
5582 | description: Unexpected error. Please check the response body for the stack | |
5583 | trace. | |
5584 | security: | |
5585 | - jwt: [] | |
5586 | summary: Deletes an NFS-Ganesha export | |
5587 | tags: | |
5588 | - NFS-Ganesha | |
5589 | get: | |
5590 | parameters: | |
5591 | - description: Cluster identifier | |
5592 | in: path | |
5593 | name: cluster_id | |
5594 | required: true | |
5595 | schema: | |
5596 | type: string | |
5597 | - description: Export ID | |
5598 | in: path | |
5599 | name: export_id | |
5600 | required: true | |
5601 | schema: | |
a4b75251 | 5602 | type: string |
f67539c2 TL |
5603 | responses: |
5604 | '200': | |
5605 | content: | |
5606 | application/vnd.ceph.api.v1.0+json: | |
5607 | schema: | |
5608 | properties: | |
5609 | access_type: | |
5610 | description: Export access type | |
5611 | type: string | |
5612 | clients: | |
5613 | description: List of client configurations | |
5614 | items: | |
5615 | properties: | |
5616 | access_type: | |
5617 | description: Client access type | |
5618 | type: string | |
5619 | addresses: | |
5620 | description: list of IP addresses | |
5621 | items: | |
5622 | type: string | |
5623 | type: array | |
5624 | squash: | |
5625 | description: Client squash policy | |
5626 | type: string | |
5627 | required: | |
5628 | - addresses | |
5629 | - access_type | |
5630 | - squash | |
5631 | type: object | |
5632 | type: array | |
5633 | cluster_id: | |
5634 | description: Cluster identifier | |
5635 | type: string | |
f67539c2 TL |
5636 | export_id: |
5637 | description: Export ID | |
5638 | type: integer | |
5639 | fsal: | |
5640 | description: FSAL configuration | |
5641 | properties: | |
a4b75251 TL |
5642 | fs_name: |
5643 | description: CephFS filesystem name | |
f67539c2 TL |
5644 | type: string |
5645 | name: | |
5646 | description: name of FSAL | |
5647 | type: string | |
f67539c2 TL |
5648 | sec_label_xattr: |
5649 | description: Name of xattr for security label | |
5650 | type: string | |
5651 | user_id: | |
a4b75251 | 5652 | description: User id |
f67539c2 TL |
5653 | type: string |
5654 | required: | |
5655 | - name | |
5656 | type: object | |
5657 | path: | |
5658 | description: Export path | |
5659 | type: string | |
5660 | protocols: | |
5661 | description: List of protocol types | |
5662 | items: | |
5663 | type: integer | |
5664 | type: array | |
5665 | pseudo: | |
5666 | description: Pseudo FS path | |
5667 | type: string | |
5668 | security_label: | |
5669 | description: Security label | |
5670 | type: string | |
5671 | squash: | |
5672 | description: Export squash policy | |
5673 | type: string | |
f67539c2 TL |
5674 | transports: |
5675 | description: List of transport types | |
5676 | items: | |
5677 | type: string | |
5678 | type: array | |
5679 | required: | |
5680 | - export_id | |
5681 | - path | |
5682 | - cluster_id | |
f67539c2 | 5683 | - pseudo |
f67539c2 TL |
5684 | - access_type |
5685 | - squash | |
5686 | - security_label | |
5687 | - protocols | |
5688 | - transports | |
5689 | - fsal | |
5690 | - clients | |
5691 | type: object | |
5692 | description: OK | |
5693 | '400': | |
5694 | description: Operation exception. Please check the response body for details. | |
5695 | '401': | |
5696 | description: Unauthenticated access. Please login first. | |
5697 | '403': | |
5698 | description: Unauthorized access. Please check your permissions. | |
5699 | '500': | |
5700 | description: Unexpected error. Please check the response body for the stack | |
5701 | trace. | |
5702 | security: | |
5703 | - jwt: [] | |
5704 | summary: Get an NFS-Ganesha export | |
5705 | tags: | |
5706 | - NFS-Ganesha | |
5707 | put: | |
5708 | parameters: | |
5709 | - description: Cluster identifier | |
5710 | in: path | |
5711 | name: cluster_id | |
5712 | required: true | |
5713 | schema: | |
5714 | type: string | |
5715 | - description: Export ID | |
5716 | in: path | |
5717 | name: export_id | |
5718 | required: true | |
5719 | schema: | |
5720 | type: integer | |
5721 | requestBody: | |
5722 | content: | |
5723 | application/json: | |
5724 | schema: | |
5725 | properties: | |
5726 | access_type: | |
5727 | description: Export access type | |
5728 | type: string | |
5729 | clients: | |
5730 | description: List of client configurations | |
5731 | items: | |
5732 | properties: | |
5733 | access_type: | |
5734 | description: Client access type | |
5735 | type: string | |
5736 | addresses: | |
5737 | description: list of IP addresses | |
5738 | items: | |
5739 | type: string | |
5740 | type: array | |
5741 | squash: | |
5742 | description: Client squash policy | |
5743 | type: string | |
5744 | required: | |
5745 | - addresses | |
5746 | - access_type | |
5747 | - squash | |
5748 | type: object | |
5749 | type: array | |
f67539c2 TL |
5750 | fsal: |
5751 | description: FSAL configuration | |
5752 | properties: | |
a4b75251 TL |
5753 | fs_name: |
5754 | description: CephFS filesystem name | |
f67539c2 TL |
5755 | type: string |
5756 | name: | |
5757 | description: name of FSAL | |
5758 | type: string | |
f67539c2 TL |
5759 | sec_label_xattr: |
5760 | description: Name of xattr for security label | |
5761 | type: string | |
f67539c2 TL |
5762 | required: |
5763 | - name | |
5764 | type: object | |
5765 | path: | |
5766 | description: Export path | |
5767 | type: string | |
5768 | protocols: | |
5769 | description: List of protocol types | |
5770 | items: | |
5771 | type: integer | |
5772 | type: array | |
5773 | pseudo: | |
5774 | description: Pseudo FS path | |
5775 | type: string | |
f67539c2 TL |
5776 | security_label: |
5777 | description: Security label | |
5778 | type: string | |
5779 | squash: | |
5780 | description: Export squash policy | |
5781 | type: string | |
f67539c2 TL |
5782 | transports: |
5783 | description: List of transport types | |
5784 | items: | |
5785 | type: string | |
5786 | type: array | |
5787 | required: | |
5788 | - path | |
f67539c2 | 5789 | - pseudo |
f67539c2 TL |
5790 | - access_type |
5791 | - squash | |
5792 | - security_label | |
5793 | - protocols | |
5794 | - transports | |
5795 | - fsal | |
5796 | - clients | |
5797 | type: object | |
5798 | responses: | |
5799 | '200': | |
5800 | content: | |
a4b75251 | 5801 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5802 | schema: |
5803 | properties: | |
5804 | access_type: | |
5805 | description: Export access type | |
5806 | type: string | |
5807 | clients: | |
5808 | description: List of client configurations | |
5809 | items: | |
5810 | properties: | |
5811 | access_type: | |
5812 | description: Client access type | |
5813 | type: string | |
5814 | addresses: | |
5815 | description: list of IP addresses | |
5816 | items: | |
5817 | type: string | |
5818 | type: array | |
5819 | squash: | |
5820 | description: Client squash policy | |
5821 | type: string | |
5822 | required: | |
5823 | - addresses | |
5824 | - access_type | |
5825 | - squash | |
5826 | type: object | |
5827 | type: array | |
5828 | cluster_id: | |
5829 | description: Cluster identifier | |
5830 | type: string | |
f67539c2 TL |
5831 | export_id: |
5832 | description: Export ID | |
5833 | type: integer | |
5834 | fsal: | |
5835 | description: FSAL configuration | |
5836 | properties: | |
a4b75251 TL |
5837 | fs_name: |
5838 | description: CephFS filesystem name | |
f67539c2 TL |
5839 | type: string |
5840 | name: | |
5841 | description: name of FSAL | |
5842 | type: string | |
f67539c2 TL |
5843 | sec_label_xattr: |
5844 | description: Name of xattr for security label | |
5845 | type: string | |
5846 | user_id: | |
a4b75251 | 5847 | description: User id |
f67539c2 TL |
5848 | type: string |
5849 | required: | |
5850 | - name | |
5851 | type: object | |
5852 | path: | |
5853 | description: Export path | |
5854 | type: string | |
5855 | protocols: | |
5856 | description: List of protocol types | |
5857 | items: | |
5858 | type: integer | |
5859 | type: array | |
5860 | pseudo: | |
5861 | description: Pseudo FS path | |
5862 | type: string | |
5863 | security_label: | |
5864 | description: Security label | |
5865 | type: string | |
5866 | squash: | |
5867 | description: Export squash policy | |
5868 | type: string | |
f67539c2 TL |
5869 | transports: |
5870 | description: List of transport types | |
5871 | items: | |
5872 | type: string | |
5873 | type: array | |
5874 | required: | |
5875 | - export_id | |
5876 | - path | |
5877 | - cluster_id | |
f67539c2 | 5878 | - pseudo |
f67539c2 TL |
5879 | - access_type |
5880 | - squash | |
5881 | - security_label | |
5882 | - protocols | |
5883 | - transports | |
5884 | - fsal | |
5885 | - clients | |
5886 | type: object | |
5887 | description: Resource updated. | |
5888 | '202': | |
5889 | content: | |
a4b75251 | 5890 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
5891 | type: object |
5892 | description: Operation is still executing. Please check the task queue. | |
5893 | '400': | |
5894 | description: Operation exception. Please check the response body for details. | |
5895 | '401': | |
5896 | description: Unauthenticated access. Please login first. | |
5897 | '403': | |
5898 | description: Unauthorized access. Please check your permissions. | |
5899 | '500': | |
5900 | description: Unexpected error. Please check the response body for the stack | |
5901 | trace. | |
5902 | security: | |
5903 | - jwt: [] | |
5904 | summary: Updates an NFS-Ganesha export | |
5905 | tags: | |
5906 | - NFS-Ganesha | |
f67539c2 TL |
5907 | /api/osd: |
5908 | get: | |
5909 | parameters: [] | |
5910 | responses: | |
5911 | '200': | |
5912 | content: | |
5913 | application/vnd.ceph.api.v1.0+json: | |
5914 | type: object | |
5915 | description: OK | |
5916 | '400': | |
5917 | description: Operation exception. Please check the response body for details. | |
5918 | '401': | |
5919 | description: Unauthenticated access. Please login first. | |
5920 | '403': | |
5921 | description: Unauthorized access. Please check your permissions. | |
5922 | '500': | |
5923 | description: Unexpected error. Please check the response body for the stack | |
5924 | trace. | |
5925 | security: | |
5926 | - jwt: [] | |
5927 | tags: | |
5928 | - OSD | |
5929 | post: | |
5930 | parameters: [] | |
5931 | requestBody: | |
5932 | content: | |
5933 | application/json: | |
5934 | schema: | |
5935 | properties: | |
5936 | data: | |
5937 | type: string | |
5938 | method: | |
5939 | type: string | |
5940 | tracking_id: | |
5941 | type: string | |
5942 | required: | |
5943 | - method | |
5944 | - data | |
5945 | - tracking_id | |
5946 | type: object | |
5947 | responses: | |
5948 | '201': | |
5949 | content: | |
5950 | application/vnd.ceph.api.v1.0+json: | |
5951 | type: object | |
5952 | description: Resource created. | |
5953 | '202': | |
5954 | content: | |
5955 | application/vnd.ceph.api.v1.0+json: | |
5956 | type: object | |
5957 | description: Operation is still executing. Please check the task queue. | |
5958 | '400': | |
5959 | description: Operation exception. Please check the response body for details. | |
5960 | '401': | |
5961 | description: Unauthenticated access. Please login first. | |
5962 | '403': | |
5963 | description: Unauthorized access. Please check your permissions. | |
5964 | '500': | |
5965 | description: Unexpected error. Please check the response body for the stack | |
5966 | trace. | |
5967 | security: | |
5968 | - jwt: [] | |
5969 | tags: | |
5970 | - OSD | |
5971 | /api/osd/flags: | |
5972 | get: | |
5973 | parameters: [] | |
5974 | responses: | |
5975 | '200': | |
5976 | content: | |
5977 | application/vnd.ceph.api.v1.0+json: | |
5978 | schema: | |
5979 | properties: | |
5980 | list_of_flags: | |
5981 | description: '' | |
5982 | items: | |
5983 | type: string | |
5984 | type: array | |
5985 | required: | |
5986 | - list_of_flags | |
5987 | type: object | |
5988 | description: OK | |
5989 | '400': | |
5990 | description: Operation exception. Please check the response body for details. | |
5991 | '401': | |
5992 | description: Unauthenticated access. Please login first. | |
5993 | '403': | |
5994 | description: Unauthorized access. Please check your permissions. | |
5995 | '500': | |
5996 | description: Unexpected error. Please check the response body for the stack | |
5997 | trace. | |
5998 | security: | |
5999 | - jwt: [] | |
6000 | summary: Display OSD Flags | |
6001 | tags: | |
6002 | - OSD | |
6003 | put: | |
6004 | description: "\n The `recovery_deletes`, `sortbitwise` and `pglog_hardlimit`\ | |
6005 | \ flags cannot be unset.\n `purged_snapshots` cannot even be set. It\ | |
6006 | \ is therefore required to at\n least include those four flags for\ | |
6007 | \ a successful operation.\n " | |
6008 | parameters: [] | |
6009 | requestBody: | |
6010 | content: | |
6011 | application/json: | |
6012 | schema: | |
6013 | properties: | |
6014 | flags: | |
6015 | description: List of flags to set. The flags `recovery_deletes`, | |
6016 | `sortbitwise` and `pglog_hardlimit` cannot be unset. Additionally | |
6017 | `purged_snapshots` cannot even be set. | |
6018 | items: | |
6019 | type: string | |
6020 | type: array | |
6021 | required: | |
6022 | - flags | |
6023 | type: object | |
6024 | responses: | |
6025 | '200': | |
6026 | content: | |
6027 | application/vnd.ceph.api.v1.0+json: | |
6028 | schema: | |
6029 | properties: | |
6030 | list_of_flags: | |
6031 | description: '' | |
6032 | items: | |
6033 | type: string | |
6034 | type: array | |
6035 | required: | |
6036 | - list_of_flags | |
6037 | type: object | |
6038 | description: Resource updated. | |
6039 | '202': | |
6040 | content: | |
6041 | application/vnd.ceph.api.v1.0+json: | |
6042 | type: object | |
6043 | description: Operation is still executing. Please check the task queue. | |
6044 | '400': | |
6045 | description: Operation exception. Please check the response body for details. | |
6046 | '401': | |
6047 | description: Unauthenticated access. Please login first. | |
6048 | '403': | |
6049 | description: Unauthorized access. Please check your permissions. | |
6050 | '500': | |
6051 | description: Unexpected error. Please check the response body for the stack | |
6052 | trace. | |
6053 | security: | |
6054 | - jwt: [] | |
6055 | summary: Sets OSD flags for the entire cluster. | |
6056 | tags: | |
6057 | - OSD | |
6058 | /api/osd/flags/individual: | |
6059 | get: | |
6060 | parameters: [] | |
6061 | responses: | |
6062 | '200': | |
6063 | content: | |
6064 | application/vnd.ceph.api.v1.0+json: | |
6065 | schema: | |
6066 | properties: | |
6067 | flags: | |
6068 | description: List of active flags | |
6069 | items: | |
6070 | type: string | |
6071 | type: array | |
6072 | osd: | |
6073 | description: OSD ID | |
6074 | type: integer | |
6075 | required: | |
6076 | - osd | |
6077 | - flags | |
6078 | type: object | |
6079 | description: OK | |
6080 | '400': | |
6081 | description: Operation exception. Please check the response body for details. | |
6082 | '401': | |
6083 | description: Unauthenticated access. Please login first. | |
6084 | '403': | |
6085 | description: Unauthorized access. Please check your permissions. | |
6086 | '500': | |
6087 | description: Unexpected error. Please check the response body for the stack | |
6088 | trace. | |
6089 | security: | |
6090 | - jwt: [] | |
6091 | summary: Displays individual OSD flags | |
6092 | tags: | |
6093 | - OSD | |
6094 | put: | |
6095 | description: "\n Updates flags (`noout`, `noin`, `nodown`, `noup`) for\ | |
6096 | \ an individual\n subset of OSDs.\n " | |
6097 | parameters: [] | |
6098 | requestBody: | |
6099 | content: | |
6100 | application/json: | |
6101 | schema: | |
6102 | properties: | |
6103 | flags: | |
6104 | description: Directory of flags to set or unset. The flags `noin`, | |
6105 | `noout`, `noup` and `nodown` are going to be considered only. | |
6106 | properties: | |
6107 | nodown: | |
6108 | description: Sets/unsets `nodown` | |
6109 | type: boolean | |
6110 | noin: | |
6111 | description: Sets/unsets `noin` | |
6112 | type: boolean | |
6113 | noout: | |
6114 | description: Sets/unsets `noout` | |
6115 | type: boolean | |
6116 | noup: | |
6117 | description: Sets/unsets `noup` | |
6118 | type: boolean | |
6119 | type: object | |
6120 | ids: | |
6121 | description: List of OSD ids the flags should be applied to. | |
6122 | items: | |
6123 | type: integer | |
6124 | type: array | |
6125 | required: | |
6126 | - flags | |
6127 | - ids | |
6128 | type: object | |
6129 | responses: | |
6130 | '200': | |
6131 | content: | |
6132 | application/vnd.ceph.api.v1.0+json: | |
6133 | schema: | |
6134 | properties: | |
6135 | added: | |
6136 | description: List of added flags | |
6137 | items: | |
6138 | type: string | |
6139 | type: array | |
6140 | ids: | |
6141 | description: List of updated OSDs | |
6142 | items: | |
6143 | type: integer | |
6144 | type: array | |
6145 | removed: | |
6146 | description: List of removed flags | |
6147 | items: | |
6148 | type: string | |
6149 | type: array | |
6150 | required: | |
6151 | - added | |
6152 | - removed | |
6153 | - ids | |
6154 | type: object | |
6155 | description: Resource updated. | |
6156 | '202': | |
6157 | content: | |
6158 | application/vnd.ceph.api.v1.0+json: | |
6159 | type: object | |
6160 | description: Operation is still executing. Please check the task queue. | |
6161 | '400': | |
6162 | description: Operation exception. Please check the response body for details. | |
6163 | '401': | |
6164 | description: Unauthenticated access. Please login first. | |
6165 | '403': | |
6166 | description: Unauthorized access. Please check your permissions. | |
6167 | '500': | |
6168 | description: Unexpected error. Please check the response body for the stack | |
6169 | trace. | |
6170 | security: | |
6171 | - jwt: [] | |
6172 | summary: Sets OSD flags for a subset of individual OSDs. | |
6173 | tags: | |
6174 | - OSD | |
6175 | /api/osd/safe_to_delete: | |
6176 | get: | |
6177 | description: "\n :type ids: int|[int]\n " | |
6178 | parameters: | |
6179 | - in: query | |
6180 | name: svc_ids | |
6181 | required: true | |
6182 | schema: | |
6183 | type: string | |
6184 | responses: | |
6185 | '200': | |
6186 | content: | |
6187 | application/vnd.ceph.api.v1.0+json: | |
6188 | type: object | |
6189 | description: OK | |
6190 | '400': | |
6191 | description: Operation exception. Please check the response body for details. | |
6192 | '401': | |
6193 | description: Unauthenticated access. Please login first. | |
6194 | '403': | |
6195 | description: Unauthorized access. Please check your permissions. | |
6196 | '500': | |
6197 | description: Unexpected error. Please check the response body for the stack | |
6198 | trace. | |
6199 | security: | |
6200 | - jwt: [] | |
6201 | tags: | |
6202 | - OSD | |
6203 | /api/osd/safe_to_destroy: | |
6204 | get: | |
6205 | description: "\n :type ids: int|[int]\n " | |
6206 | parameters: | |
6207 | - description: OSD Service Identifier | |
6208 | in: query | |
6209 | name: ids | |
6210 | required: true | |
6211 | schema: | |
6212 | type: string | |
6213 | responses: | |
6214 | '200': | |
6215 | content: | |
6216 | application/vnd.ceph.api.v1.0+json: | |
6217 | schema: | |
6218 | properties: | |
6219 | active: | |
6220 | description: '' | |
6221 | items: | |
6222 | type: integer | |
6223 | type: array | |
6224 | is_safe_to_destroy: | |
6225 | description: Is OSD safe to destroy? | |
6226 | type: boolean | |
6227 | missing_stats: | |
6228 | description: '' | |
6229 | items: | |
6230 | type: string | |
6231 | type: array | |
6232 | safe_to_destroy: | |
6233 | description: Is OSD safe to destroy? | |
6234 | items: | |
6235 | type: string | |
6236 | type: array | |
6237 | stored_pgs: | |
6238 | description: Stored Pool groups in Osd | |
6239 | items: | |
6240 | type: string | |
6241 | type: array | |
6242 | required: | |
6243 | - safe_to_destroy | |
6244 | - active | |
6245 | - missing_stats | |
6246 | - stored_pgs | |
6247 | - is_safe_to_destroy | |
6248 | type: object | |
6249 | description: OK | |
6250 | '400': | |
6251 | description: Operation exception. Please check the response body for details. | |
6252 | '401': | |
6253 | description: Unauthenticated access. Please login first. | |
6254 | '403': | |
6255 | description: Unauthorized access. Please check your permissions. | |
6256 | '500': | |
6257 | description: Unexpected error. Please check the response body for the stack | |
6258 | trace. | |
6259 | security: | |
6260 | - jwt: [] | |
6261 | summary: Check If OSD is Safe to Destroy | |
6262 | tags: | |
6263 | - OSD | |
20effc67 TL |
6264 | /api/osd/settings: |
6265 | get: | |
6266 | parameters: [] | |
6267 | responses: | |
6268 | '200': | |
6269 | content: | |
6270 | application/vnd.ceph.api.v0.1+json: | |
6271 | type: object | |
6272 | description: OK | |
6273 | '400': | |
6274 | description: Operation exception. Please check the response body for details. | |
6275 | '401': | |
6276 | description: Unauthenticated access. Please login first. | |
6277 | '403': | |
6278 | description: Unauthorized access. Please check your permissions. | |
6279 | '500': | |
6280 | description: Unexpected error. Please check the response body for the stack | |
6281 | trace. | |
6282 | security: | |
6283 | - jwt: [] | |
6284 | tags: | |
6285 | - OSD | |
f67539c2 TL |
6286 | /api/osd/{svc_id}: |
6287 | delete: | |
6288 | parameters: | |
6289 | - in: path | |
6290 | name: svc_id | |
6291 | required: true | |
6292 | schema: | |
6293 | type: string | |
6294 | - allowEmptyValue: true | |
6295 | in: query | |
6296 | name: preserve_id | |
6297 | schema: | |
6298 | type: string | |
6299 | - allowEmptyValue: true | |
6300 | in: query | |
6301 | name: force | |
6302 | schema: | |
6303 | type: string | |
6304 | responses: | |
6305 | '202': | |
6306 | content: | |
6307 | application/vnd.ceph.api.v1.0+json: | |
6308 | type: object | |
6309 | description: Operation is still executing. Please check the task queue. | |
6310 | '204': | |
6311 | content: | |
6312 | application/vnd.ceph.api.v1.0+json: | |
6313 | type: object | |
6314 | description: Resource deleted. | |
6315 | '400': | |
6316 | description: Operation exception. Please check the response body for details. | |
6317 | '401': | |
6318 | description: Unauthenticated access. Please login first. | |
6319 | '403': | |
6320 | description: Unauthorized access. Please check your permissions. | |
6321 | '500': | |
6322 | description: Unexpected error. Please check the response body for the stack | |
6323 | trace. | |
6324 | security: | |
6325 | - jwt: [] | |
6326 | tags: | |
6327 | - OSD | |
6328 | get: | |
6329 | description: "\n Returns collected data about an OSD.\n\n :return:\ | |
6330 | \ Returns the requested data.\n " | |
6331 | parameters: | |
6332 | - in: path | |
6333 | name: svc_id | |
6334 | required: true | |
6335 | schema: | |
6336 | type: string | |
6337 | responses: | |
6338 | '200': | |
6339 | content: | |
6340 | application/vnd.ceph.api.v1.0+json: | |
6341 | type: object | |
6342 | description: OK | |
6343 | '400': | |
6344 | description: Operation exception. Please check the response body for details. | |
6345 | '401': | |
6346 | description: Unauthenticated access. Please login first. | |
6347 | '403': | |
6348 | description: Unauthorized access. Please check your permissions. | |
6349 | '500': | |
6350 | description: Unexpected error. Please check the response body for the stack | |
6351 | trace. | |
6352 | security: | |
6353 | - jwt: [] | |
6354 | tags: | |
6355 | - OSD | |
6356 | put: | |
6357 | parameters: | |
6358 | - in: path | |
6359 | name: svc_id | |
6360 | required: true | |
6361 | schema: | |
6362 | type: string | |
6363 | requestBody: | |
6364 | content: | |
6365 | application/json: | |
6366 | schema: | |
6367 | properties: | |
6368 | device_class: | |
6369 | type: string | |
6370 | required: | |
6371 | - device_class | |
6372 | type: object | |
6373 | responses: | |
6374 | '200': | |
6375 | content: | |
6376 | application/vnd.ceph.api.v1.0+json: | |
6377 | type: object | |
6378 | description: Resource updated. | |
6379 | '202': | |
6380 | content: | |
6381 | application/vnd.ceph.api.v1.0+json: | |
6382 | type: object | |
6383 | description: Operation is still executing. Please check the task queue. | |
6384 | '400': | |
6385 | description: Operation exception. Please check the response body for details. | |
6386 | '401': | |
6387 | description: Unauthenticated access. Please login first. | |
6388 | '403': | |
6389 | description: Unauthorized access. Please check your permissions. | |
6390 | '500': | |
6391 | description: Unexpected error. Please check the response body for the stack | |
6392 | trace. | |
6393 | security: | |
6394 | - jwt: [] | |
6395 | tags: | |
6396 | - OSD | |
6397 | /api/osd/{svc_id}/destroy: | |
6398 | post: | |
6399 | description: "\n Mark osd as being destroyed. Keeps the ID intact (allowing\ | |
6400 | \ reuse), but\n removes cephx keys, config-key data and lockbox keys,\ | |
6401 | \ rendering data\n permanently unreadable.\n\n The osd must\ | |
6402 | \ be marked down before being destroyed.\n " | |
6403 | parameters: | |
6404 | - in: path | |
6405 | name: svc_id | |
6406 | required: true | |
6407 | schema: | |
6408 | type: string | |
6409 | responses: | |
6410 | '201': | |
6411 | content: | |
6412 | application/vnd.ceph.api.v1.0+json: | |
6413 | type: object | |
6414 | description: Resource created. | |
6415 | '202': | |
6416 | content: | |
6417 | application/vnd.ceph.api.v1.0+json: | |
6418 | type: object | |
6419 | description: Operation is still executing. Please check the task queue. | |
6420 | '400': | |
6421 | description: Operation exception. Please check the response body for details. | |
6422 | '401': | |
6423 | description: Unauthenticated access. Please login first. | |
6424 | '403': | |
6425 | description: Unauthorized access. Please check your permissions. | |
6426 | '500': | |
6427 | description: Unexpected error. Please check the response body for the stack | |
6428 | trace. | |
6429 | security: | |
6430 | - jwt: [] | |
6431 | tags: | |
6432 | - OSD | |
6433 | /api/osd/{svc_id}/devices: | |
6434 | get: | |
6435 | parameters: | |
6436 | - in: path | |
6437 | name: svc_id | |
6438 | required: true | |
6439 | schema: | |
6440 | type: string | |
6441 | responses: | |
6442 | '200': | |
6443 | content: | |
6444 | application/vnd.ceph.api.v1.0+json: | |
6445 | type: object | |
6446 | description: OK | |
6447 | '400': | |
6448 | description: Operation exception. Please check the response body for details. | |
6449 | '401': | |
6450 | description: Unauthenticated access. Please login first. | |
6451 | '403': | |
6452 | description: Unauthorized access. Please check your permissions. | |
6453 | '500': | |
6454 | description: Unexpected error. Please check the response body for the stack | |
6455 | trace. | |
6456 | security: | |
6457 | - jwt: [] | |
6458 | tags: | |
6459 | - OSD | |
6460 | /api/osd/{svc_id}/histogram: | |
6461 | get: | |
6462 | description: "\n :return: Returns the histogram data.\n " | |
6463 | parameters: | |
6464 | - in: path | |
6465 | name: svc_id | |
6466 | required: true | |
6467 | schema: | |
6468 | type: string | |
6469 | responses: | |
6470 | '200': | |
6471 | content: | |
6472 | application/vnd.ceph.api.v1.0+json: | |
6473 | type: object | |
6474 | description: OK | |
6475 | '400': | |
6476 | description: Operation exception. Please check the response body for details. | |
6477 | '401': | |
6478 | description: Unauthenticated access. Please login first. | |
6479 | '403': | |
6480 | description: Unauthorized access. Please check your permissions. | |
6481 | '500': | |
6482 | description: Unexpected error. Please check the response body for the stack | |
6483 | trace. | |
6484 | security: | |
6485 | - jwt: [] | |
6486 | tags: | |
6487 | - OSD | |
6488 | /api/osd/{svc_id}/mark: | |
6489 | put: | |
6490 | description: "\n Note: osd must be marked `down` before marking lost.\n\ | |
6491 | \ " | |
6492 | parameters: | |
6493 | - description: SVC ID | |
6494 | in: path | |
6495 | name: svc_id | |
6496 | required: true | |
6497 | schema: | |
6498 | type: string | |
6499 | requestBody: | |
6500 | content: | |
6501 | application/json: | |
6502 | schema: | |
6503 | properties: | |
6504 | action: | |
6505 | type: string | |
6506 | required: | |
6507 | - action | |
6508 | type: object | |
6509 | responses: | |
6510 | '200': | |
6511 | content: | |
6512 | application/vnd.ceph.api.v1.0+json: | |
6513 | type: object | |
6514 | description: Resource updated. | |
6515 | '202': | |
6516 | content: | |
6517 | application/vnd.ceph.api.v1.0+json: | |
6518 | type: object | |
6519 | description: Operation is still executing. Please check the task queue. | |
6520 | '400': | |
6521 | description: Operation exception. Please check the response body for details. | |
6522 | '401': | |
6523 | description: Unauthenticated access. Please login first. | |
6524 | '403': | |
6525 | description: Unauthorized access. Please check your permissions. | |
6526 | '500': | |
6527 | description: Unexpected error. Please check the response body for the stack | |
6528 | trace. | |
6529 | security: | |
6530 | - jwt: [] | |
6531 | summary: Mark OSD flags (out, in, down, lost, ...) | |
6532 | tags: | |
6533 | - OSD | |
6534 | /api/osd/{svc_id}/purge: | |
6535 | post: | |
6536 | description: "\n Note: osd must be marked `down` before removal.\n \ | |
6537 | \ " | |
6538 | parameters: | |
6539 | - in: path | |
6540 | name: svc_id | |
6541 | required: true | |
6542 | schema: | |
6543 | type: string | |
6544 | responses: | |
6545 | '201': | |
6546 | content: | |
6547 | application/vnd.ceph.api.v1.0+json: | |
6548 | type: object | |
6549 | description: Resource created. | |
6550 | '202': | |
6551 | content: | |
6552 | application/vnd.ceph.api.v1.0+json: | |
6553 | type: object | |
6554 | description: Operation is still executing. Please check the task queue. | |
6555 | '400': | |
6556 | description: Operation exception. Please check the response body for details. | |
6557 | '401': | |
6558 | description: Unauthenticated access. Please login first. | |
6559 | '403': | |
6560 | description: Unauthorized access. Please check your permissions. | |
6561 | '500': | |
6562 | description: Unexpected error. Please check the response body for the stack | |
6563 | trace. | |
6564 | security: | |
6565 | - jwt: [] | |
6566 | tags: | |
6567 | - OSD | |
6568 | /api/osd/{svc_id}/reweight: | |
6569 | post: | |
6570 | description: "\n Reweights the OSD temporarily.\n\n Note that\ | |
6571 | \ \u2018ceph osd reweight\u2019 is not a persistent setting. When an OSD\n\ | |
6572 | \ gets marked out, the osd weight will be set to 0. When it gets marked\n\ | |
6573 | \ in again, the weight will be changed to 1.\n\n Because of\ | |
6574 | \ this \u2018ceph osd reweight\u2019 is a temporary solution. You should\n\ | |
6575 | \ only use it to keep your cluster running while you\u2019re ordering\ | |
6576 | \ more\n hardware.\n\n - Craig Lewis (http://lists.ceph.com/pipermail/ceph-users-ceph.com/2014-June/040967.html)\n\ | |
6577 | \ " | |
6578 | parameters: | |
6579 | - in: path | |
6580 | name: svc_id | |
6581 | required: true | |
6582 | schema: | |
6583 | type: string | |
6584 | requestBody: | |
6585 | content: | |
6586 | application/json: | |
6587 | schema: | |
6588 | properties: | |
6589 | weight: | |
6590 | type: string | |
6591 | required: | |
6592 | - weight | |
6593 | type: object | |
6594 | responses: | |
6595 | '201': | |
6596 | content: | |
6597 | application/vnd.ceph.api.v1.0+json: | |
6598 | type: object | |
6599 | description: Resource created. | |
6600 | '202': | |
6601 | content: | |
6602 | application/vnd.ceph.api.v1.0+json: | |
6603 | type: object | |
6604 | description: Operation is still executing. Please check the task queue. | |
6605 | '400': | |
6606 | description: Operation exception. Please check the response body for details. | |
6607 | '401': | |
6608 | description: Unauthenticated access. Please login first. | |
6609 | '403': | |
6610 | description: Unauthorized access. Please check your permissions. | |
6611 | '500': | |
6612 | description: Unexpected error. Please check the response body for the stack | |
6613 | trace. | |
6614 | security: | |
6615 | - jwt: [] | |
6616 | tags: | |
6617 | - OSD | |
6618 | /api/osd/{svc_id}/scrub: | |
6619 | post: | |
6620 | parameters: | |
6621 | - in: path | |
6622 | name: svc_id | |
6623 | required: true | |
6624 | schema: | |
6625 | type: string | |
6626 | - default: false | |
6627 | in: query | |
6628 | name: deep | |
6629 | schema: | |
6630 | type: boolean | |
6631 | requestBody: | |
6632 | content: | |
6633 | application/json: | |
6634 | schema: | |
6635 | properties: | |
6636 | deep: | |
6637 | default: false | |
6638 | type: boolean | |
6639 | type: object | |
6640 | responses: | |
6641 | '201': | |
6642 | content: | |
6643 | application/vnd.ceph.api.v1.0+json: | |
6644 | type: object | |
6645 | description: Resource created. | |
6646 | '202': | |
6647 | content: | |
6648 | application/vnd.ceph.api.v1.0+json: | |
6649 | type: object | |
6650 | description: Operation is still executing. Please check the task queue. | |
6651 | '400': | |
6652 | description: Operation exception. Please check the response body for details. | |
6653 | '401': | |
6654 | description: Unauthenticated access. Please login first. | |
6655 | '403': | |
6656 | description: Unauthorized access. Please check your permissions. | |
6657 | '500': | |
6658 | description: Unexpected error. Please check the response body for the stack | |
6659 | trace. | |
6660 | security: | |
6661 | - jwt: [] | |
6662 | tags: | |
6663 | - OSD | |
6664 | /api/osd/{svc_id}/smart: | |
6665 | get: | |
6666 | parameters: | |
6667 | - in: path | |
6668 | name: svc_id | |
6669 | required: true | |
6670 | schema: | |
6671 | type: string | |
6672 | responses: | |
6673 | '200': | |
6674 | content: | |
6675 | application/vnd.ceph.api.v1.0+json: | |
6676 | type: object | |
6677 | description: OK | |
6678 | '400': | |
6679 | description: Operation exception. Please check the response body for details. | |
6680 | '401': | |
6681 | description: Unauthenticated access. Please login first. | |
6682 | '403': | |
6683 | description: Unauthorized access. Please check your permissions. | |
6684 | '500': | |
6685 | description: Unexpected error. Please check the response body for the stack | |
6686 | trace. | |
6687 | security: | |
6688 | - jwt: [] | |
6689 | tags: | |
6690 | - OSD | |
6691 | /api/perf_counters: | |
6692 | get: | |
6693 | parameters: [] | |
6694 | responses: | |
6695 | '200': | |
6696 | content: | |
6697 | application/vnd.ceph.api.v1.0+json: | |
6698 | schema: | |
6699 | properties: | |
6700 | mon.a: | |
6701 | description: Service ID | |
6702 | properties: | |
6703 | .cache_bytes: | |
6704 | description: '' | |
6705 | properties: | |
6706 | description: | |
6707 | description: '' | |
6708 | type: string | |
6709 | nick: | |
6710 | description: '' | |
6711 | type: string | |
6712 | priority: | |
6713 | description: '' | |
6714 | type: integer | |
6715 | type: | |
6716 | description: '' | |
6717 | type: integer | |
6718 | units: | |
6719 | description: '' | |
6720 | type: integer | |
6721 | value: | |
6722 | description: '' | |
6723 | type: integer | |
6724 | required: | |
6725 | - description | |
6726 | - nick | |
6727 | - type | |
6728 | - priority | |
6729 | - units | |
6730 | - value | |
6731 | type: object | |
6732 | required: | |
6733 | - .cache_bytes | |
6734 | type: object | |
6735 | required: | |
6736 | - mon.a | |
6737 | type: object | |
6738 | description: OK | |
6739 | '400': | |
6740 | description: Operation exception. Please check the response body for details. | |
6741 | '401': | |
6742 | description: Unauthenticated access. Please login first. | |
6743 | '403': | |
6744 | description: Unauthorized access. Please check your permissions. | |
6745 | '500': | |
6746 | description: Unexpected error. Please check the response body for the stack | |
6747 | trace. | |
6748 | security: | |
6749 | - jwt: [] | |
6750 | summary: Display Perf Counters | |
6751 | tags: | |
6752 | - PerfCounters | |
6753 | /api/perf_counters/mds/{service_id}: | |
6754 | get: | |
6755 | parameters: | |
6756 | - in: path | |
6757 | name: service_id | |
6758 | required: true | |
6759 | schema: | |
6760 | type: string | |
6761 | responses: | |
6762 | '200': | |
6763 | content: | |
6764 | application/vnd.ceph.api.v1.0+json: | |
6765 | type: object | |
6766 | description: OK | |
6767 | '400': | |
6768 | description: Operation exception. Please check the response body for details. | |
6769 | '401': | |
6770 | description: Unauthenticated access. Please login first. | |
6771 | '403': | |
6772 | description: Unauthorized access. Please check your permissions. | |
6773 | '500': | |
6774 | description: Unexpected error. Please check the response body for the stack | |
6775 | trace. | |
6776 | security: | |
6777 | - jwt: [] | |
6778 | tags: | |
6779 | - MdsPerfCounter | |
6780 | /api/perf_counters/mgr/{service_id}: | |
6781 | get: | |
6782 | parameters: | |
6783 | - in: path | |
6784 | name: service_id | |
6785 | required: true | |
6786 | schema: | |
6787 | type: string | |
6788 | responses: | |
6789 | '200': | |
6790 | content: | |
6791 | application/vnd.ceph.api.v1.0+json: | |
6792 | type: object | |
6793 | description: OK | |
6794 | '400': | |
6795 | description: Operation exception. Please check the response body for details. | |
6796 | '401': | |
6797 | description: Unauthenticated access. Please login first. | |
6798 | '403': | |
6799 | description: Unauthorized access. Please check your permissions. | |
6800 | '500': | |
6801 | description: Unexpected error. Please check the response body for the stack | |
6802 | trace. | |
6803 | security: | |
6804 | - jwt: [] | |
6805 | tags: | |
6806 | - MgrPerfCounter | |
6807 | /api/perf_counters/mon/{service_id}: | |
6808 | get: | |
6809 | parameters: | |
6810 | - in: path | |
6811 | name: service_id | |
6812 | required: true | |
6813 | schema: | |
6814 | type: string | |
6815 | responses: | |
6816 | '200': | |
6817 | content: | |
6818 | application/vnd.ceph.api.v1.0+json: | |
6819 | type: object | |
6820 | description: OK | |
6821 | '400': | |
6822 | description: Operation exception. Please check the response body for details. | |
6823 | '401': | |
6824 | description: Unauthenticated access. Please login first. | |
6825 | '403': | |
6826 | description: Unauthorized access. Please check your permissions. | |
6827 | '500': | |
6828 | description: Unexpected error. Please check the response body for the stack | |
6829 | trace. | |
6830 | security: | |
6831 | - jwt: [] | |
6832 | tags: | |
6833 | - MonPerfCounter | |
6834 | /api/perf_counters/osd/{service_id}: | |
6835 | get: | |
6836 | parameters: | |
6837 | - in: path | |
6838 | name: service_id | |
6839 | required: true | |
6840 | schema: | |
6841 | type: string | |
6842 | responses: | |
6843 | '200': | |
6844 | content: | |
6845 | application/vnd.ceph.api.v1.0+json: | |
6846 | type: object | |
6847 | description: OK | |
6848 | '400': | |
6849 | description: Operation exception. Please check the response body for details. | |
6850 | '401': | |
6851 | description: Unauthenticated access. Please login first. | |
6852 | '403': | |
6853 | description: Unauthorized access. Please check your permissions. | |
6854 | '500': | |
6855 | description: Unexpected error. Please check the response body for the stack | |
6856 | trace. | |
6857 | security: | |
6858 | - jwt: [] | |
6859 | tags: | |
6860 | - OsdPerfCounter | |
6861 | /api/perf_counters/rbd-mirror/{service_id}: | |
6862 | get: | |
6863 | parameters: | |
6864 | - in: path | |
6865 | name: service_id | |
6866 | required: true | |
6867 | schema: | |
6868 | type: string | |
6869 | responses: | |
6870 | '200': | |
6871 | content: | |
6872 | application/vnd.ceph.api.v1.0+json: | |
6873 | type: object | |
6874 | description: OK | |
6875 | '400': | |
6876 | description: Operation exception. Please check the response body for details. | |
6877 | '401': | |
6878 | description: Unauthenticated access. Please login first. | |
6879 | '403': | |
6880 | description: Unauthorized access. Please check your permissions. | |
6881 | '500': | |
6882 | description: Unexpected error. Please check the response body for the stack | |
6883 | trace. | |
6884 | security: | |
6885 | - jwt: [] | |
6886 | tags: | |
6887 | - RgwMirrorPerfCounter | |
6888 | /api/perf_counters/rgw/{service_id}: | |
6889 | get: | |
6890 | parameters: | |
6891 | - in: path | |
6892 | name: service_id | |
6893 | required: true | |
6894 | schema: | |
6895 | type: string | |
6896 | responses: | |
6897 | '200': | |
6898 | content: | |
6899 | application/vnd.ceph.api.v1.0+json: | |
6900 | type: object | |
6901 | description: OK | |
6902 | '400': | |
6903 | description: Operation exception. Please check the response body for details. | |
6904 | '401': | |
6905 | description: Unauthenticated access. Please login first. | |
6906 | '403': | |
6907 | description: Unauthorized access. Please check your permissions. | |
6908 | '500': | |
6909 | description: Unexpected error. Please check the response body for the stack | |
6910 | trace. | |
6911 | security: | |
6912 | - jwt: [] | |
6913 | tags: | |
6914 | - RgwPerfCounter | |
6915 | /api/perf_counters/tcmu-runner/{service_id}: | |
6916 | get: | |
6917 | parameters: | |
6918 | - in: path | |
6919 | name: service_id | |
6920 | required: true | |
6921 | schema: | |
6922 | type: string | |
6923 | responses: | |
6924 | '200': | |
6925 | content: | |
6926 | application/vnd.ceph.api.v1.0+json: | |
6927 | type: object | |
6928 | description: OK | |
6929 | '400': | |
6930 | description: Operation exception. Please check the response body for details. | |
6931 | '401': | |
6932 | description: Unauthenticated access. Please login first. | |
6933 | '403': | |
6934 | description: Unauthorized access. Please check your permissions. | |
6935 | '500': | |
6936 | description: Unexpected error. Please check the response body for the stack | |
6937 | trace. | |
6938 | security: | |
6939 | - jwt: [] | |
6940 | tags: | |
6941 | - TcmuRunnerPerfCounter | |
6942 | /api/pool: | |
6943 | get: | |
6944 | parameters: | |
6945 | - allowEmptyValue: true | |
6946 | description: Pool Attributes | |
6947 | in: query | |
6948 | name: attrs | |
6949 | schema: | |
6950 | type: string | |
6951 | - default: false | |
6952 | description: Pool Stats | |
6953 | in: query | |
6954 | name: stats | |
6955 | schema: | |
6956 | type: boolean | |
6957 | responses: | |
6958 | '200': | |
6959 | content: | |
6960 | application/vnd.ceph.api.v1.0+json: | |
6961 | schema: | |
6962 | items: | |
6963 | properties: | |
6964 | application_metadata: | |
6965 | description: '' | |
6966 | items: | |
6967 | type: string | |
6968 | type: array | |
6969 | auid: | |
6970 | description: '' | |
6971 | type: integer | |
6972 | cache_min_evict_age: | |
6973 | description: '' | |
6974 | type: integer | |
6975 | cache_min_flush_age: | |
6976 | description: '' | |
6977 | type: integer | |
6978 | cache_mode: | |
6979 | description: '' | |
6980 | type: string | |
6981 | cache_target_dirty_high_ratio_micro: | |
6982 | description: '' | |
6983 | type: integer | |
6984 | cache_target_dirty_ratio_micro: | |
6985 | description: '' | |
6986 | type: integer | |
6987 | cache_target_full_ratio_micro: | |
6988 | description: '' | |
6989 | type: integer | |
6990 | create_time: | |
6991 | description: '' | |
6992 | type: string | |
6993 | crush_rule: | |
6994 | description: '' | |
6995 | type: string | |
6996 | erasure_code_profile: | |
6997 | description: '' | |
6998 | type: string | |
6999 | expected_num_objects: | |
7000 | description: '' | |
7001 | type: integer | |
7002 | fast_read: | |
7003 | description: '' | |
7004 | type: boolean | |
7005 | flags: | |
7006 | description: '' | |
7007 | type: integer | |
7008 | flags_names: | |
7009 | description: flags name | |
7010 | type: string | |
7011 | grade_table: | |
7012 | description: '' | |
7013 | items: | |
7014 | type: string | |
7015 | type: array | |
7016 | hit_set_count: | |
7017 | description: '' | |
7018 | type: integer | |
7019 | hit_set_grade_decay_rate: | |
7020 | description: '' | |
7021 | type: integer | |
7022 | hit_set_params: | |
7023 | description: '' | |
7024 | properties: | |
7025 | type: | |
7026 | description: '' | |
7027 | type: string | |
7028 | required: | |
7029 | - type | |
7030 | type: object | |
7031 | hit_set_period: | |
7032 | description: '' | |
7033 | type: integer | |
7034 | hit_set_search_last_n: | |
7035 | description: '' | |
7036 | type: integer | |
7037 | last_change: | |
7038 | description: '' | |
7039 | type: string | |
7040 | last_force_op_resend: | |
7041 | description: '' | |
7042 | type: string | |
7043 | last_force_op_resend_preluminous: | |
7044 | description: '' | |
7045 | type: string | |
7046 | last_force_op_resend_prenautilus: | |
7047 | description: '' | |
7048 | type: string | |
7049 | last_pg_merge_meta: | |
7050 | description: '' | |
7051 | properties: | |
7052 | last_epoch_clean: | |
7053 | description: '' | |
7054 | type: integer | |
7055 | last_epoch_started: | |
7056 | description: '' | |
7057 | type: integer | |
7058 | ready_epoch: | |
7059 | description: '' | |
7060 | type: integer | |
7061 | source_pgid: | |
7062 | description: '' | |
7063 | type: string | |
7064 | source_version: | |
7065 | description: '' | |
7066 | type: string | |
7067 | target_version: | |
7068 | description: '' | |
7069 | type: string | |
7070 | required: | |
7071 | - ready_epoch | |
7072 | - last_epoch_started | |
7073 | - last_epoch_clean | |
7074 | - source_pgid | |
7075 | - source_version | |
7076 | - target_version | |
7077 | type: object | |
7078 | min_read_recency_for_promote: | |
7079 | description: '' | |
7080 | type: integer | |
7081 | min_size: | |
7082 | description: '' | |
7083 | type: integer | |
7084 | min_write_recency_for_promote: | |
7085 | description: '' | |
7086 | type: integer | |
7087 | object_hash: | |
7088 | description: '' | |
7089 | type: integer | |
7090 | options: | |
7091 | description: '' | |
7092 | properties: | |
20effc67 TL |
7093 | pg_num_max: |
7094 | description: '' | |
7095 | type: integer | |
f67539c2 TL |
7096 | pg_num_min: |
7097 | description: '' | |
7098 | type: integer | |
7099 | required: | |
7100 | - pg_num_min | |
20effc67 | 7101 | - pg_num_max |
f67539c2 TL |
7102 | type: object |
7103 | pg_autoscale_mode: | |
7104 | description: '' | |
7105 | type: string | |
7106 | pg_num: | |
7107 | description: '' | |
7108 | type: integer | |
7109 | pg_num_pending: | |
7110 | description: '' | |
7111 | type: integer | |
7112 | pg_num_target: | |
7113 | description: '' | |
7114 | type: integer | |
7115 | pg_placement_num: | |
7116 | description: '' | |
7117 | type: integer | |
7118 | pg_placement_num_target: | |
7119 | description: '' | |
7120 | type: integer | |
7121 | pool: | |
7122 | description: pool id | |
7123 | type: integer | |
7124 | pool_name: | |
7125 | description: pool name | |
7126 | type: string | |
7127 | pool_snaps: | |
7128 | description: '' | |
7129 | items: | |
7130 | type: string | |
7131 | type: array | |
7132 | quota_max_bytes: | |
7133 | description: '' | |
7134 | type: integer | |
7135 | quota_max_objects: | |
7136 | description: '' | |
7137 | type: integer | |
7138 | read_tier: | |
7139 | description: '' | |
7140 | type: integer | |
7141 | removed_snaps: | |
7142 | description: '' | |
7143 | items: | |
7144 | type: string | |
7145 | type: array | |
7146 | size: | |
7147 | description: pool size | |
7148 | type: integer | |
7149 | snap_epoch: | |
7150 | description: '' | |
7151 | type: integer | |
7152 | snap_mode: | |
7153 | description: '' | |
7154 | type: string | |
7155 | snap_seq: | |
7156 | description: '' | |
7157 | type: integer | |
7158 | stripe_width: | |
7159 | description: '' | |
7160 | type: integer | |
7161 | target_max_bytes: | |
7162 | description: '' | |
7163 | type: integer | |
7164 | target_max_objects: | |
7165 | description: '' | |
7166 | type: integer | |
7167 | tier_of: | |
7168 | description: '' | |
7169 | type: integer | |
7170 | tiers: | |
7171 | description: '' | |
7172 | items: | |
7173 | type: string | |
7174 | type: array | |
7175 | type: | |
7176 | description: type of pool | |
7177 | type: string | |
7178 | use_gmt_hitset: | |
7179 | description: '' | |
7180 | type: boolean | |
7181 | write_tier: | |
7182 | description: '' | |
7183 | type: integer | |
7184 | type: object | |
7185 | required: | |
7186 | - pool | |
7187 | - pool_name | |
7188 | - flags | |
7189 | - flags_names | |
7190 | - type | |
7191 | - size | |
7192 | - min_size | |
7193 | - crush_rule | |
7194 | - object_hash | |
7195 | - pg_autoscale_mode | |
7196 | - pg_num | |
7197 | - pg_placement_num | |
7198 | - pg_placement_num_target | |
7199 | - pg_num_target | |
7200 | - pg_num_pending | |
7201 | - last_pg_merge_meta | |
7202 | - auid | |
7203 | - snap_mode | |
7204 | - snap_seq | |
7205 | - snap_epoch | |
7206 | - pool_snaps | |
7207 | - quota_max_bytes | |
7208 | - quota_max_objects | |
7209 | - tiers | |
7210 | - tier_of | |
7211 | - read_tier | |
7212 | - write_tier | |
7213 | - cache_mode | |
7214 | - target_max_bytes | |
7215 | - target_max_objects | |
7216 | - cache_target_dirty_ratio_micro | |
7217 | - cache_target_dirty_high_ratio_micro | |
7218 | - cache_target_full_ratio_micro | |
7219 | - cache_min_flush_age | |
7220 | - cache_min_evict_age | |
7221 | - erasure_code_profile | |
7222 | - hit_set_params | |
7223 | - hit_set_period | |
7224 | - hit_set_count | |
7225 | - use_gmt_hitset | |
7226 | - min_read_recency_for_promote | |
7227 | - min_write_recency_for_promote | |
7228 | - hit_set_grade_decay_rate | |
7229 | - hit_set_search_last_n | |
7230 | - grade_table | |
7231 | - stripe_width | |
7232 | - expected_num_objects | |
7233 | - fast_read | |
7234 | - options | |
7235 | - application_metadata | |
7236 | - create_time | |
7237 | - last_change | |
7238 | - last_force_op_resend | |
7239 | - last_force_op_resend_prenautilus | |
7240 | - last_force_op_resend_preluminous | |
7241 | - removed_snaps | |
7242 | type: array | |
7243 | description: OK | |
7244 | '400': | |
7245 | description: Operation exception. Please check the response body for details. | |
7246 | '401': | |
7247 | description: Unauthenticated access. Please login first. | |
7248 | '403': | |
7249 | description: Unauthorized access. Please check your permissions. | |
7250 | '500': | |
7251 | description: Unexpected error. Please check the response body for the stack | |
7252 | trace. | |
7253 | security: | |
7254 | - jwt: [] | |
7255 | summary: Display Pool List | |
7256 | tags: | |
7257 | - Pool | |
7258 | post: | |
7259 | parameters: [] | |
7260 | requestBody: | |
7261 | content: | |
7262 | application/json: | |
7263 | schema: | |
7264 | properties: | |
f67539c2 | 7265 | pool: |
2a845540 | 7266 | default: rbd-mirror |
f67539c2 | 7267 | type: string |
f67539c2 TL |
7268 | type: object |
7269 | responses: | |
7270 | '201': | |
7271 | content: | |
7272 | application/vnd.ceph.api.v1.0+json: | |
7273 | type: object | |
7274 | description: Resource created. | |
7275 | '202': | |
7276 | content: | |
7277 | application/vnd.ceph.api.v1.0+json: | |
7278 | type: object | |
7279 | description: Operation is still executing. Please check the task queue. | |
7280 | '400': | |
7281 | description: Operation exception. Please check the response body for details. | |
7282 | '401': | |
7283 | description: Unauthenticated access. Please login first. | |
7284 | '403': | |
7285 | description: Unauthorized access. Please check your permissions. | |
7286 | '500': | |
7287 | description: Unexpected error. Please check the response body for the stack | |
7288 | trace. | |
7289 | security: | |
7290 | - jwt: [] | |
7291 | tags: | |
7292 | - Pool | |
7293 | /api/pool/{pool_name}: | |
7294 | delete: | |
7295 | parameters: | |
7296 | - in: path | |
7297 | name: pool_name | |
7298 | required: true | |
7299 | schema: | |
7300 | type: string | |
7301 | responses: | |
7302 | '202': | |
7303 | content: | |
7304 | application/vnd.ceph.api.v1.0+json: | |
7305 | type: object | |
7306 | description: Operation is still executing. Please check the task queue. | |
7307 | '204': | |
7308 | content: | |
7309 | application/vnd.ceph.api.v1.0+json: | |
7310 | type: object | |
7311 | description: Resource deleted. | |
7312 | '400': | |
7313 | description: Operation exception. Please check the response body for details. | |
7314 | '401': | |
7315 | description: Unauthenticated access. Please login first. | |
7316 | '403': | |
7317 | description: Unauthorized access. Please check your permissions. | |
7318 | '500': | |
7319 | description: Unexpected error. Please check the response body for the stack | |
7320 | trace. | |
7321 | security: | |
7322 | - jwt: [] | |
7323 | tags: | |
7324 | - Pool | |
7325 | get: | |
7326 | parameters: | |
7327 | - in: path | |
7328 | name: pool_name | |
7329 | required: true | |
7330 | schema: | |
7331 | type: string | |
7332 | - allowEmptyValue: true | |
7333 | in: query | |
7334 | name: attrs | |
7335 | schema: | |
7336 | type: string | |
7337 | - default: false | |
7338 | in: query | |
7339 | name: stats | |
7340 | schema: | |
7341 | type: boolean | |
7342 | responses: | |
7343 | '200': | |
7344 | content: | |
7345 | application/vnd.ceph.api.v1.0+json: | |
7346 | type: object | |
7347 | description: OK | |
7348 | '400': | |
7349 | description: Operation exception. Please check the response body for details. | |
7350 | '401': | |
7351 | description: Unauthenticated access. Please login first. | |
7352 | '403': | |
7353 | description: Unauthorized access. Please check your permissions. | |
7354 | '500': | |
7355 | description: Unexpected error. Please check the response body for the stack | |
7356 | trace. | |
7357 | security: | |
7358 | - jwt: [] | |
7359 | tags: | |
7360 | - Pool | |
7361 | put: | |
7362 | parameters: | |
7363 | - in: path | |
7364 | name: pool_name | |
7365 | required: true | |
7366 | schema: | |
7367 | type: string | |
7368 | requestBody: | |
7369 | content: | |
7370 | application/json: | |
7371 | schema: | |
7372 | properties: | |
7373 | application_metadata: | |
7374 | type: string | |
7375 | configuration: | |
7376 | type: string | |
7377 | flags: | |
7378 | type: string | |
7379 | type: object | |
7380 | responses: | |
7381 | '200': | |
7382 | content: | |
7383 | application/vnd.ceph.api.v1.0+json: | |
7384 | type: object | |
7385 | description: Resource updated. | |
7386 | '202': | |
7387 | content: | |
7388 | application/vnd.ceph.api.v1.0+json: | |
7389 | type: object | |
7390 | description: Operation is still executing. Please check the task queue. | |
7391 | '400': | |
7392 | description: Operation exception. Please check the response body for details. | |
7393 | '401': | |
7394 | description: Unauthenticated access. Please login first. | |
7395 | '403': | |
7396 | description: Unauthorized access. Please check your permissions. | |
7397 | '500': | |
7398 | description: Unexpected error. Please check the response body for the stack | |
7399 | trace. | |
7400 | security: | |
7401 | - jwt: [] | |
7402 | tags: | |
7403 | - Pool | |
7404 | /api/pool/{pool_name}/configuration: | |
7405 | get: | |
7406 | parameters: | |
7407 | - in: path | |
7408 | name: pool_name | |
7409 | required: true | |
7410 | schema: | |
7411 | type: string | |
7412 | responses: | |
7413 | '200': | |
7414 | content: | |
7415 | application/vnd.ceph.api.v1.0+json: | |
7416 | type: object | |
7417 | description: OK | |
7418 | '400': | |
7419 | description: Operation exception. Please check the response body for details. | |
7420 | '401': | |
7421 | description: Unauthenticated access. Please login first. | |
7422 | '403': | |
7423 | description: Unauthorized access. Please check your permissions. | |
7424 | '500': | |
7425 | description: Unexpected error. Please check the response body for the stack | |
7426 | trace. | |
7427 | security: | |
7428 | - jwt: [] | |
7429 | tags: | |
7430 | - Pool | |
7431 | /api/prometheus: | |
7432 | get: | |
7433 | parameters: [] | |
7434 | responses: | |
7435 | '200': | |
7436 | content: | |
7437 | application/vnd.ceph.api.v1.0+json: | |
7438 | type: object | |
7439 | description: OK | |
7440 | '400': | |
7441 | description: Operation exception. Please check the response body for details. | |
7442 | '401': | |
7443 | description: Unauthenticated access. Please login first. | |
7444 | '403': | |
7445 | description: Unauthorized access. Please check your permissions. | |
7446 | '500': | |
7447 | description: Unexpected error. Please check the response body for the stack | |
7448 | trace. | |
7449 | security: | |
7450 | - jwt: [] | |
7451 | tags: | |
7452 | - Prometheus | |
7453 | /api/prometheus/notifications: | |
7454 | get: | |
7455 | parameters: [] | |
7456 | responses: | |
7457 | '200': | |
7458 | content: | |
7459 | application/vnd.ceph.api.v1.0+json: | |
7460 | type: object | |
7461 | description: OK | |
7462 | '400': | |
7463 | description: Operation exception. Please check the response body for details. | |
7464 | '401': | |
7465 | description: Unauthenticated access. Please login first. | |
7466 | '403': | |
7467 | description: Unauthorized access. Please check your permissions. | |
7468 | '500': | |
7469 | description: Unexpected error. Please check the response body for the stack | |
7470 | trace. | |
7471 | security: | |
7472 | - jwt: [] | |
7473 | tags: | |
7474 | - PrometheusNotifications | |
7475 | /api/prometheus/rules: | |
7476 | get: | |
7477 | parameters: [] | |
7478 | responses: | |
7479 | '200': | |
7480 | content: | |
7481 | application/vnd.ceph.api.v1.0+json: | |
7482 | type: object | |
7483 | description: OK | |
7484 | '400': | |
7485 | description: Operation exception. Please check the response body for details. | |
7486 | '401': | |
7487 | description: Unauthenticated access. Please login first. | |
7488 | '403': | |
7489 | description: Unauthorized access. Please check your permissions. | |
7490 | '500': | |
7491 | description: Unexpected error. Please check the response body for the stack | |
7492 | trace. | |
7493 | security: | |
7494 | - jwt: [] | |
7495 | tags: | |
7496 | - Prometheus | |
7497 | /api/prometheus/silence: | |
7498 | post: | |
7499 | parameters: [] | |
7500 | responses: | |
7501 | '201': | |
7502 | content: | |
7503 | application/vnd.ceph.api.v1.0+json: | |
7504 | type: object | |
7505 | description: Resource created. | |
7506 | '202': | |
7507 | content: | |
7508 | application/vnd.ceph.api.v1.0+json: | |
7509 | type: object | |
7510 | description: Operation is still executing. Please check the task queue. | |
7511 | '400': | |
7512 | description: Operation exception. Please check the response body for details. | |
7513 | '401': | |
7514 | description: Unauthenticated access. Please login first. | |
7515 | '403': | |
7516 | description: Unauthorized access. Please check your permissions. | |
7517 | '500': | |
7518 | description: Unexpected error. Please check the response body for the stack | |
7519 | trace. | |
7520 | security: | |
7521 | - jwt: [] | |
7522 | tags: | |
7523 | - Prometheus | |
7524 | /api/prometheus/silence/{s_id}: | |
7525 | delete: | |
7526 | parameters: | |
7527 | - in: path | |
7528 | name: s_id | |
7529 | required: true | |
7530 | schema: | |
7531 | type: string | |
7532 | responses: | |
7533 | '202': | |
7534 | content: | |
7535 | application/vnd.ceph.api.v1.0+json: | |
7536 | type: object | |
7537 | description: Operation is still executing. Please check the task queue. | |
7538 | '204': | |
7539 | content: | |
7540 | application/vnd.ceph.api.v1.0+json: | |
7541 | type: object | |
7542 | description: Resource deleted. | |
7543 | '400': | |
7544 | description: Operation exception. Please check the response body for details. | |
7545 | '401': | |
7546 | description: Unauthenticated access. Please login first. | |
7547 | '403': | |
7548 | description: Unauthorized access. Please check your permissions. | |
7549 | '500': | |
7550 | description: Unexpected error. Please check the response body for the stack | |
7551 | trace. | |
7552 | security: | |
7553 | - jwt: [] | |
7554 | tags: | |
7555 | - Prometheus | |
7556 | /api/prometheus/silences: | |
7557 | get: | |
7558 | parameters: [] | |
7559 | responses: | |
7560 | '200': | |
7561 | content: | |
7562 | application/vnd.ceph.api.v1.0+json: | |
7563 | type: object | |
7564 | description: OK | |
7565 | '400': | |
7566 | description: Operation exception. Please check the response body for details. | |
7567 | '401': | |
7568 | description: Unauthenticated access. Please login first. | |
7569 | '403': | |
7570 | description: Unauthorized access. Please check your permissions. | |
7571 | '500': | |
7572 | description: Unexpected error. Please check the response body for the stack | |
7573 | trace. | |
7574 | security: | |
7575 | - jwt: [] | |
7576 | tags: | |
7577 | - Prometheus | |
7578 | /api/rgw/bucket: | |
7579 | get: | |
7580 | parameters: | |
7581 | - default: false | |
7582 | in: query | |
7583 | name: stats | |
7584 | schema: | |
7585 | type: boolean | |
7586 | - allowEmptyValue: true | |
7587 | in: query | |
7588 | name: daemon_name | |
7589 | schema: | |
7590 | type: string | |
a4b75251 TL |
7591 | - allowEmptyValue: true |
7592 | in: query | |
7593 | name: uid | |
7594 | schema: | |
7595 | type: string | |
f67539c2 TL |
7596 | responses: |
7597 | '200': | |
7598 | content: | |
a4b75251 | 7599 | application/vnd.ceph.api.v1.1+json: |
f67539c2 TL |
7600 | type: object |
7601 | description: OK | |
7602 | '400': | |
7603 | description: Operation exception. Please check the response body for details. | |
7604 | '401': | |
7605 | description: Unauthenticated access. Please login first. | |
7606 | '403': | |
7607 | description: Unauthorized access. Please check your permissions. | |
7608 | '500': | |
7609 | description: Unexpected error. Please check the response body for the stack | |
7610 | trace. | |
7611 | security: | |
7612 | - jwt: [] | |
7613 | tags: | |
7614 | - RgwBucket | |
7615 | post: | |
7616 | parameters: [] | |
7617 | requestBody: | |
7618 | content: | |
7619 | application/json: | |
7620 | schema: | |
7621 | properties: | |
7622 | bucket: | |
7623 | type: string | |
7624 | daemon_name: | |
7625 | type: string | |
39ae355f TL |
7626 | encryption_state: |
7627 | default: 'false' | |
7628 | type: string | |
7629 | encryption_type: | |
7630 | type: string | |
7631 | key_id: | |
7632 | type: string | |
f67539c2 TL |
7633 | lock_enabled: |
7634 | default: 'false' | |
7635 | type: string | |
7636 | lock_mode: | |
7637 | type: string | |
7638 | lock_retention_period_days: | |
7639 | type: string | |
7640 | lock_retention_period_years: | |
7641 | type: string | |
7642 | placement_target: | |
7643 | type: string | |
7644 | uid: | |
7645 | type: string | |
7646 | zonegroup: | |
7647 | type: string | |
7648 | required: | |
7649 | - bucket | |
7650 | - uid | |
7651 | type: object | |
7652 | responses: | |
7653 | '201': | |
7654 | content: | |
7655 | application/vnd.ceph.api.v1.0+json: | |
7656 | type: object | |
7657 | description: Resource created. | |
7658 | '202': | |
7659 | content: | |
7660 | application/vnd.ceph.api.v1.0+json: | |
7661 | type: object | |
7662 | description: Operation is still executing. Please check the task queue. | |
7663 | '400': | |
7664 | description: Operation exception. Please check the response body for details. | |
7665 | '401': | |
7666 | description: Unauthenticated access. Please login first. | |
7667 | '403': | |
7668 | description: Unauthorized access. Please check your permissions. | |
7669 | '500': | |
7670 | description: Unexpected error. Please check the response body for the stack | |
7671 | trace. | |
7672 | security: | |
7673 | - jwt: [] | |
7674 | tags: | |
7675 | - RgwBucket | |
39ae355f TL |
7676 | /api/rgw/bucket/deleteEncryption: |
7677 | delete: | |
7678 | parameters: | |
7679 | - in: query | |
7680 | name: bucket_name | |
7681 | required: true | |
7682 | schema: | |
7683 | type: string | |
7684 | - allowEmptyValue: true | |
7685 | in: query | |
7686 | name: daemon_name | |
7687 | schema: | |
7688 | type: string | |
7689 | - allowEmptyValue: true | |
7690 | in: query | |
7691 | name: owner | |
7692 | schema: | |
7693 | type: string | |
7694 | responses: | |
7695 | '202': | |
7696 | content: | |
7697 | application/vnd.ceph.api.v1.0+json: | |
7698 | type: object | |
7699 | description: Operation is still executing. Please check the task queue. | |
7700 | '204': | |
7701 | content: | |
7702 | application/vnd.ceph.api.v1.0+json: | |
7703 | type: object | |
7704 | description: Resource deleted. | |
7705 | '400': | |
7706 | description: Operation exception. Please check the response body for details. | |
7707 | '401': | |
7708 | description: Unauthenticated access. Please login first. | |
7709 | '403': | |
7710 | description: Unauthorized access. Please check your permissions. | |
7711 | '500': | |
7712 | description: Unexpected error. Please check the response body for the stack | |
7713 | trace. | |
7714 | security: | |
7715 | - jwt: [] | |
7716 | tags: | |
7717 | - RgwBucket | |
7718 | /api/rgw/bucket/getEncryption: | |
7719 | get: | |
7720 | parameters: | |
7721 | - in: query | |
7722 | name: bucket_name | |
7723 | required: true | |
7724 | schema: | |
7725 | type: string | |
7726 | - allowEmptyValue: true | |
7727 | in: query | |
7728 | name: daemon_name | |
7729 | schema: | |
7730 | type: string | |
7731 | - allowEmptyValue: true | |
7732 | in: query | |
7733 | name: owner | |
7734 | schema: | |
7735 | type: string | |
7736 | responses: | |
7737 | '200': | |
7738 | content: | |
7739 | application/vnd.ceph.api.v1.0+json: | |
7740 | type: object | |
7741 | description: OK | |
7742 | '400': | |
7743 | description: Operation exception. Please check the response body for details. | |
7744 | '401': | |
7745 | description: Unauthenticated access. Please login first. | |
7746 | '403': | |
7747 | description: Unauthorized access. Please check your permissions. | |
7748 | '500': | |
7749 | description: Unexpected error. Please check the response body for the stack | |
7750 | trace. | |
7751 | security: | |
7752 | - jwt: [] | |
7753 | tags: | |
7754 | - RgwBucket | |
7755 | /api/rgw/bucket/getEncryptionConfig: | |
7756 | get: | |
7757 | parameters: | |
7758 | - allowEmptyValue: true | |
7759 | in: query | |
7760 | name: daemon_name | |
7761 | schema: | |
7762 | type: string | |
7763 | - allowEmptyValue: true | |
7764 | in: query | |
7765 | name: owner | |
7766 | schema: | |
7767 | type: string | |
7768 | responses: | |
7769 | '200': | |
7770 | content: | |
7771 | application/vnd.ceph.api.v1.0+json: | |
7772 | type: object | |
7773 | description: OK | |
7774 | '400': | |
7775 | description: Operation exception. Please check the response body for details. | |
7776 | '401': | |
7777 | description: Unauthenticated access. Please login first. | |
7778 | '403': | |
7779 | description: Unauthorized access. Please check your permissions. | |
7780 | '500': | |
7781 | description: Unexpected error. Please check the response body for the stack | |
7782 | trace. | |
7783 | security: | |
7784 | - jwt: [] | |
7785 | tags: | |
7786 | - RgwBucket | |
7787 | /api/rgw/bucket/setEncryptionConfig: | |
7788 | put: | |
7789 | parameters: [] | |
7790 | requestBody: | |
7791 | content: | |
7792 | application/json: | |
7793 | schema: | |
7794 | properties: | |
7795 | address: | |
7796 | type: string | |
7797 | auth_method: | |
7798 | type: string | |
7799 | client_cert: | |
7800 | type: string | |
7801 | client_key: | |
7802 | type: string | |
7803 | daemon_name: | |
7804 | type: string | |
7805 | encryption_type: | |
7806 | type: string | |
7807 | kms_provider: | |
7808 | type: string | |
7809 | namespace: | |
7810 | default: '' | |
7811 | type: string | |
7812 | owner: | |
7813 | type: string | |
7814 | secret_engine: | |
7815 | type: string | |
7816 | secret_path: | |
7817 | default: '' | |
7818 | type: string | |
7819 | ssl_cert: | |
7820 | type: string | |
7821 | token: | |
7822 | type: string | |
7823 | type: object | |
7824 | responses: | |
7825 | '200': | |
7826 | content: | |
7827 | application/vnd.ceph.api.v1.0+json: | |
7828 | type: object | |
7829 | description: Resource updated. | |
7830 | '202': | |
7831 | content: | |
7832 | application/vnd.ceph.api.v1.0+json: | |
7833 | type: object | |
7834 | description: Operation is still executing. Please check the task queue. | |
7835 | '400': | |
7836 | description: Operation exception. Please check the response body for details. | |
7837 | '401': | |
7838 | description: Unauthenticated access. Please login first. | |
7839 | '403': | |
7840 | description: Unauthorized access. Please check your permissions. | |
7841 | '500': | |
7842 | description: Unexpected error. Please check the response body for the stack | |
7843 | trace. | |
7844 | security: | |
7845 | - jwt: [] | |
7846 | tags: | |
7847 | - RgwBucket | |
f67539c2 TL |
7848 | /api/rgw/bucket/{bucket}: |
7849 | delete: | |
7850 | parameters: | |
7851 | - in: path | |
7852 | name: bucket | |
7853 | required: true | |
7854 | schema: | |
7855 | type: string | |
7856 | - default: 'true' | |
7857 | in: query | |
7858 | name: purge_objects | |
7859 | schema: | |
7860 | type: string | |
7861 | - allowEmptyValue: true | |
7862 | in: query | |
7863 | name: daemon_name | |
7864 | schema: | |
7865 | type: string | |
7866 | responses: | |
7867 | '202': | |
7868 | content: | |
7869 | application/vnd.ceph.api.v1.0+json: | |
7870 | type: object | |
7871 | description: Operation is still executing. Please check the task queue. | |
7872 | '204': | |
7873 | content: | |
7874 | application/vnd.ceph.api.v1.0+json: | |
7875 | type: object | |
7876 | description: Resource deleted. | |
7877 | '400': | |
7878 | description: Operation exception. Please check the response body for details. | |
7879 | '401': | |
7880 | description: Unauthenticated access. Please login first. | |
7881 | '403': | |
7882 | description: Unauthorized access. Please check your permissions. | |
7883 | '500': | |
7884 | description: Unexpected error. Please check the response body for the stack | |
7885 | trace. | |
7886 | security: | |
7887 | - jwt: [] | |
7888 | tags: | |
7889 | - RgwBucket | |
7890 | get: | |
7891 | parameters: | |
7892 | - in: path | |
7893 | name: bucket | |
7894 | required: true | |
7895 | schema: | |
7896 | type: string | |
7897 | - allowEmptyValue: true | |
7898 | in: query | |
7899 | name: daemon_name | |
7900 | schema: | |
7901 | type: string | |
7902 | responses: | |
7903 | '200': | |
7904 | content: | |
7905 | application/vnd.ceph.api.v1.0+json: | |
7906 | type: object | |
7907 | description: OK | |
7908 | '400': | |
7909 | description: Operation exception. Please check the response body for details. | |
7910 | '401': | |
7911 | description: Unauthenticated access. Please login first. | |
7912 | '403': | |
7913 | description: Unauthorized access. Please check your permissions. | |
7914 | '500': | |
7915 | description: Unexpected error. Please check the response body for the stack | |
7916 | trace. | |
7917 | security: | |
7918 | - jwt: [] | |
7919 | tags: | |
7920 | - RgwBucket | |
7921 | put: | |
7922 | parameters: | |
7923 | - in: path | |
7924 | name: bucket | |
7925 | required: true | |
7926 | schema: | |
7927 | type: string | |
7928 | requestBody: | |
7929 | content: | |
7930 | application/json: | |
7931 | schema: | |
7932 | properties: | |
7933 | bucket_id: | |
7934 | type: string | |
7935 | daemon_name: | |
7936 | type: string | |
39ae355f TL |
7937 | encryption_state: |
7938 | default: 'false' | |
7939 | type: string | |
7940 | encryption_type: | |
7941 | type: string | |
7942 | key_id: | |
7943 | type: string | |
f67539c2 TL |
7944 | lock_mode: |
7945 | type: string | |
7946 | lock_retention_period_days: | |
7947 | type: string | |
7948 | lock_retention_period_years: | |
7949 | type: string | |
7950 | mfa_delete: | |
7951 | type: string | |
7952 | mfa_token_pin: | |
7953 | type: string | |
7954 | mfa_token_serial: | |
7955 | type: string | |
7956 | uid: | |
7957 | type: string | |
7958 | versioning_state: | |
7959 | type: string | |
7960 | required: | |
7961 | - bucket_id | |
7962 | - uid | |
7963 | type: object | |
7964 | responses: | |
7965 | '200': | |
7966 | content: | |
7967 | application/vnd.ceph.api.v1.0+json: | |
7968 | type: object | |
7969 | description: Resource updated. | |
7970 | '202': | |
7971 | content: | |
7972 | application/vnd.ceph.api.v1.0+json: | |
7973 | type: object | |
7974 | description: Operation is still executing. Please check the task queue. | |
7975 | '400': | |
7976 | description: Operation exception. Please check the response body for details. | |
7977 | '401': | |
7978 | description: Unauthenticated access. Please login first. | |
7979 | '403': | |
7980 | description: Unauthorized access. Please check your permissions. | |
7981 | '500': | |
7982 | description: Unexpected error. Please check the response body for the stack | |
7983 | trace. | |
7984 | security: | |
7985 | - jwt: [] | |
7986 | tags: | |
7987 | - RgwBucket | |
7988 | /api/rgw/daemon: | |
7989 | get: | |
7990 | parameters: [] | |
7991 | responses: | |
7992 | '200': | |
7993 | content: | |
7994 | application/vnd.ceph.api.v1.0+json: | |
7995 | schema: | |
7996 | items: | |
7997 | properties: | |
7998 | id: | |
7999 | description: Daemon ID | |
8000 | type: string | |
8001 | server_hostname: | |
8002 | description: '' | |
8003 | type: string | |
8004 | version: | |
8005 | description: Ceph Version | |
8006 | type: string | |
8007 | zone_name: | |
8008 | description: Zone | |
8009 | type: string | |
8010 | zonegroup_name: | |
8011 | description: Zone Group | |
8012 | type: string | |
8013 | type: object | |
8014 | required: | |
8015 | - id | |
8016 | - version | |
8017 | - server_hostname | |
8018 | - zonegroup_name | |
8019 | - zone_name | |
8020 | type: array | |
8021 | description: OK | |
8022 | '400': | |
8023 | description: Operation exception. Please check the response body for details. | |
8024 | '401': | |
8025 | description: Unauthenticated access. Please login first. | |
8026 | '403': | |
8027 | description: Unauthorized access. Please check your permissions. | |
8028 | '500': | |
8029 | description: Unexpected error. Please check the response body for the stack | |
8030 | trace. | |
8031 | security: | |
8032 | - jwt: [] | |
8033 | summary: Display RGW Daemons | |
8034 | tags: | |
8035 | - RgwDaemon | |
8036 | /api/rgw/daemon/{svc_id}: | |
8037 | get: | |
8038 | parameters: | |
8039 | - in: path | |
8040 | name: svc_id | |
8041 | required: true | |
8042 | schema: | |
8043 | type: string | |
8044 | responses: | |
8045 | '200': | |
8046 | content: | |
8047 | application/vnd.ceph.api.v1.0+json: | |
8048 | type: object | |
8049 | description: OK | |
8050 | '400': | |
8051 | description: Operation exception. Please check the response body for details. | |
8052 | '401': | |
8053 | description: Unauthenticated access. Please login first. | |
8054 | '403': | |
8055 | description: Unauthorized access. Please check your permissions. | |
8056 | '500': | |
8057 | description: Unexpected error. Please check the response body for the stack | |
8058 | trace. | |
8059 | security: | |
8060 | - jwt: [] | |
8061 | tags: | |
8062 | - RgwDaemon | |
8063 | /api/rgw/site: | |
8064 | get: | |
8065 | parameters: | |
8066 | - allowEmptyValue: true | |
8067 | in: query | |
8068 | name: query | |
8069 | schema: | |
8070 | type: string | |
8071 | - allowEmptyValue: true | |
8072 | in: query | |
8073 | name: daemon_name | |
8074 | schema: | |
8075 | type: string | |
8076 | responses: | |
8077 | '200': | |
8078 | content: | |
8079 | application/vnd.ceph.api.v1.0+json: | |
8080 | type: object | |
8081 | description: OK | |
8082 | '400': | |
8083 | description: Operation exception. Please check the response body for details. | |
8084 | '401': | |
8085 | description: Unauthenticated access. Please login first. | |
8086 | '403': | |
8087 | description: Unauthorized access. Please check your permissions. | |
8088 | '500': | |
8089 | description: Unexpected error. Please check the response body for the stack | |
8090 | trace. | |
8091 | security: | |
8092 | - jwt: [] | |
8093 | tags: | |
8094 | - RgwSite | |
f67539c2 TL |
8095 | /api/rgw/user: |
8096 | get: | |
8097 | parameters: | |
8098 | - allowEmptyValue: true | |
8099 | in: query | |
8100 | name: daemon_name | |
8101 | schema: | |
8102 | type: string | |
8103 | responses: | |
8104 | '200': | |
8105 | content: | |
8106 | application/vnd.ceph.api.v1.0+json: | |
8107 | schema: | |
8108 | properties: | |
8109 | list_of_users: | |
8110 | description: list of rgw users | |
8111 | items: | |
8112 | type: string | |
8113 | type: array | |
8114 | required: | |
8115 | - list_of_users | |
8116 | type: object | |
8117 | description: OK | |
8118 | '400': | |
8119 | description: Operation exception. Please check the response body for details. | |
8120 | '401': | |
8121 | description: Unauthenticated access. Please login first. | |
8122 | '403': | |
8123 | description: Unauthorized access. Please check your permissions. | |
8124 | '500': | |
8125 | description: Unexpected error. Please check the response body for the stack | |
8126 | trace. | |
8127 | security: | |
8128 | - jwt: [] | |
8129 | summary: Display RGW Users | |
8130 | tags: | |
8131 | - RgwUser | |
8132 | post: | |
8133 | parameters: [] | |
8134 | requestBody: | |
8135 | content: | |
8136 | application/json: | |
8137 | schema: | |
8138 | properties: | |
8139 | access_key: | |
8140 | type: string | |
8141 | daemon_name: | |
8142 | type: string | |
8143 | display_name: | |
8144 | type: string | |
8145 | email: | |
8146 | type: string | |
8147 | generate_key: | |
8148 | type: string | |
8149 | max_buckets: | |
8150 | type: string | |
8151 | secret_key: | |
8152 | type: string | |
8153 | suspended: | |
8154 | type: string | |
8155 | uid: | |
8156 | type: string | |
8157 | required: | |
8158 | - uid | |
8159 | - display_name | |
8160 | type: object | |
8161 | responses: | |
8162 | '201': | |
8163 | content: | |
8164 | application/vnd.ceph.api.v1.0+json: | |
8165 | type: object | |
8166 | description: Resource created. | |
8167 | '202': | |
8168 | content: | |
8169 | application/vnd.ceph.api.v1.0+json: | |
8170 | type: object | |
8171 | description: Operation is still executing. Please check the task queue. | |
8172 | '400': | |
8173 | description: Operation exception. Please check the response body for details. | |
8174 | '401': | |
8175 | description: Unauthenticated access. Please login first. | |
8176 | '403': | |
8177 | description: Unauthorized access. Please check your permissions. | |
8178 | '500': | |
8179 | description: Unexpected error. Please check the response body for the stack | |
8180 | trace. | |
8181 | security: | |
8182 | - jwt: [] | |
8183 | tags: | |
8184 | - RgwUser | |
8185 | /api/rgw/user/get_emails: | |
8186 | get: | |
8187 | parameters: | |
8188 | - allowEmptyValue: true | |
8189 | in: query | |
8190 | name: daemon_name | |
8191 | schema: | |
8192 | type: string | |
8193 | responses: | |
8194 | '200': | |
8195 | content: | |
8196 | application/vnd.ceph.api.v1.0+json: | |
8197 | type: object | |
8198 | description: OK | |
8199 | '400': | |
8200 | description: Operation exception. Please check the response body for details. | |
8201 | '401': | |
8202 | description: Unauthenticated access. Please login first. | |
8203 | '403': | |
8204 | description: Unauthorized access. Please check your permissions. | |
8205 | '500': | |
8206 | description: Unexpected error. Please check the response body for the stack | |
8207 | trace. | |
8208 | security: | |
8209 | - jwt: [] | |
8210 | tags: | |
8211 | - RgwUser | |
8212 | /api/rgw/user/{uid}: | |
8213 | delete: | |
8214 | parameters: | |
8215 | - in: path | |
8216 | name: uid | |
8217 | required: true | |
8218 | schema: | |
8219 | type: string | |
8220 | - allowEmptyValue: true | |
8221 | in: query | |
8222 | name: daemon_name | |
8223 | schema: | |
8224 | type: string | |
8225 | responses: | |
8226 | '202': | |
8227 | content: | |
8228 | application/vnd.ceph.api.v1.0+json: | |
8229 | type: object | |
8230 | description: Operation is still executing. Please check the task queue. | |
8231 | '204': | |
8232 | content: | |
8233 | application/vnd.ceph.api.v1.0+json: | |
8234 | type: object | |
8235 | description: Resource deleted. | |
8236 | '400': | |
8237 | description: Operation exception. Please check the response body for details. | |
8238 | '401': | |
8239 | description: Unauthenticated access. Please login first. | |
8240 | '403': | |
8241 | description: Unauthorized access. Please check your permissions. | |
8242 | '500': | |
8243 | description: Unexpected error. Please check the response body for the stack | |
8244 | trace. | |
8245 | security: | |
8246 | - jwt: [] | |
8247 | tags: | |
8248 | - RgwUser | |
8249 | get: | |
8250 | parameters: | |
8251 | - in: path | |
8252 | name: uid | |
8253 | required: true | |
8254 | schema: | |
8255 | type: string | |
8256 | - allowEmptyValue: true | |
8257 | in: query | |
8258 | name: daemon_name | |
8259 | schema: | |
8260 | type: string | |
8261 | - default: true | |
8262 | in: query | |
8263 | name: stats | |
8264 | schema: | |
8265 | type: boolean | |
8266 | responses: | |
8267 | '200': | |
8268 | content: | |
8269 | application/vnd.ceph.api.v1.0+json: | |
8270 | type: object | |
8271 | description: OK | |
8272 | '400': | |
8273 | description: Operation exception. Please check the response body for details. | |
8274 | '401': | |
8275 | description: Unauthenticated access. Please login first. | |
8276 | '403': | |
8277 | description: Unauthorized access. Please check your permissions. | |
8278 | '500': | |
8279 | description: Unexpected error. Please check the response body for the stack | |
8280 | trace. | |
8281 | security: | |
8282 | - jwt: [] | |
8283 | tags: | |
8284 | - RgwUser | |
8285 | put: | |
8286 | parameters: | |
8287 | - in: path | |
8288 | name: uid | |
8289 | required: true | |
8290 | schema: | |
8291 | type: string | |
8292 | requestBody: | |
8293 | content: | |
8294 | application/json: | |
8295 | schema: | |
8296 | properties: | |
8297 | daemon_name: | |
8298 | type: string | |
8299 | display_name: | |
8300 | type: string | |
8301 | email: | |
8302 | type: string | |
8303 | max_buckets: | |
8304 | type: string | |
8305 | suspended: | |
8306 | type: string | |
8307 | type: object | |
8308 | responses: | |
8309 | '200': | |
8310 | content: | |
8311 | application/vnd.ceph.api.v1.0+json: | |
8312 | type: object | |
8313 | description: Resource updated. | |
8314 | '202': | |
8315 | content: | |
8316 | application/vnd.ceph.api.v1.0+json: | |
8317 | type: object | |
8318 | description: Operation is still executing. Please check the task queue. | |
8319 | '400': | |
8320 | description: Operation exception. Please check the response body for details. | |
8321 | '401': | |
8322 | description: Unauthenticated access. Please login first. | |
8323 | '403': | |
8324 | description: Unauthorized access. Please check your permissions. | |
8325 | '500': | |
8326 | description: Unexpected error. Please check the response body for the stack | |
8327 | trace. | |
8328 | security: | |
8329 | - jwt: [] | |
8330 | tags: | |
8331 | - RgwUser | |
8332 | /api/rgw/user/{uid}/capability: | |
8333 | delete: | |
8334 | parameters: | |
8335 | - in: path | |
8336 | name: uid | |
8337 | required: true | |
8338 | schema: | |
8339 | type: string | |
8340 | - in: query | |
8341 | name: type | |
8342 | required: true | |
8343 | schema: | |
8344 | type: string | |
8345 | - in: query | |
8346 | name: perm | |
8347 | required: true | |
8348 | schema: | |
8349 | type: string | |
8350 | - allowEmptyValue: true | |
8351 | in: query | |
8352 | name: daemon_name | |
8353 | schema: | |
8354 | type: string | |
8355 | responses: | |
8356 | '202': | |
8357 | content: | |
8358 | application/vnd.ceph.api.v1.0+json: | |
8359 | type: object | |
8360 | description: Operation is still executing. Please check the task queue. | |
8361 | '204': | |
8362 | content: | |
8363 | application/vnd.ceph.api.v1.0+json: | |
8364 | type: object | |
8365 | description: Resource deleted. | |
8366 | '400': | |
8367 | description: Operation exception. Please check the response body for details. | |
8368 | '401': | |
8369 | description: Unauthenticated access. Please login first. | |
8370 | '403': | |
8371 | description: Unauthorized access. Please check your permissions. | |
8372 | '500': | |
8373 | description: Unexpected error. Please check the response body for the stack | |
8374 | trace. | |
8375 | security: | |
8376 | - jwt: [] | |
8377 | tags: | |
8378 | - RgwUser | |
8379 | post: | |
8380 | parameters: | |
8381 | - in: path | |
8382 | name: uid | |
8383 | required: true | |
8384 | schema: | |
8385 | type: string | |
8386 | requestBody: | |
8387 | content: | |
8388 | application/json: | |
8389 | schema: | |
8390 | properties: | |
8391 | daemon_name: | |
8392 | type: string | |
8393 | perm: | |
8394 | type: string | |
8395 | type: | |
8396 | type: string | |
8397 | required: | |
8398 | - type | |
8399 | - perm | |
8400 | type: object | |
8401 | responses: | |
8402 | '201': | |
8403 | content: | |
8404 | application/vnd.ceph.api.v1.0+json: | |
8405 | type: object | |
8406 | description: Resource created. | |
8407 | '202': | |
8408 | content: | |
8409 | application/vnd.ceph.api.v1.0+json: | |
8410 | type: object | |
8411 | description: Operation is still executing. Please check the task queue. | |
8412 | '400': | |
8413 | description: Operation exception. Please check the response body for details. | |
8414 | '401': | |
8415 | description: Unauthenticated access. Please login first. | |
8416 | '403': | |
8417 | description: Unauthorized access. Please check your permissions. | |
8418 | '500': | |
8419 | description: Unexpected error. Please check the response body for the stack | |
8420 | trace. | |
8421 | security: | |
8422 | - jwt: [] | |
8423 | tags: | |
8424 | - RgwUser | |
8425 | /api/rgw/user/{uid}/key: | |
8426 | delete: | |
8427 | parameters: | |
8428 | - in: path | |
8429 | name: uid | |
8430 | required: true | |
8431 | schema: | |
8432 | type: string | |
8433 | - default: s3 | |
8434 | in: query | |
8435 | name: key_type | |
8436 | schema: | |
8437 | type: string | |
8438 | - allowEmptyValue: true | |
8439 | in: query | |
8440 | name: subuser | |
8441 | schema: | |
8442 | type: string | |
8443 | - allowEmptyValue: true | |
8444 | in: query | |
8445 | name: access_key | |
8446 | schema: | |
8447 | type: string | |
8448 | - allowEmptyValue: true | |
8449 | in: query | |
8450 | name: daemon_name | |
8451 | schema: | |
8452 | type: string | |
8453 | responses: | |
8454 | '202': | |
8455 | content: | |
8456 | application/vnd.ceph.api.v1.0+json: | |
8457 | type: object | |
8458 | description: Operation is still executing. Please check the task queue. | |
8459 | '204': | |
8460 | content: | |
8461 | application/vnd.ceph.api.v1.0+json: | |
8462 | type: object | |
8463 | description: Resource deleted. | |
8464 | '400': | |
8465 | description: Operation exception. Please check the response body for details. | |
8466 | '401': | |
8467 | description: Unauthenticated access. Please login first. | |
8468 | '403': | |
8469 | description: Unauthorized access. Please check your permissions. | |
8470 | '500': | |
8471 | description: Unexpected error. Please check the response body for the stack | |
8472 | trace. | |
8473 | security: | |
8474 | - jwt: [] | |
8475 | tags: | |
8476 | - RgwUser | |
8477 | post: | |
8478 | parameters: | |
8479 | - in: path | |
8480 | name: uid | |
8481 | required: true | |
8482 | schema: | |
8483 | type: string | |
8484 | requestBody: | |
8485 | content: | |
8486 | application/json: | |
8487 | schema: | |
8488 | properties: | |
8489 | access_key: | |
8490 | type: string | |
8491 | daemon_name: | |
8492 | type: string | |
8493 | generate_key: | |
8494 | default: 'true' | |
8495 | type: string | |
8496 | key_type: | |
8497 | default: s3 | |
8498 | type: string | |
8499 | secret_key: | |
8500 | type: string | |
8501 | subuser: | |
8502 | type: string | |
8503 | type: object | |
8504 | responses: | |
8505 | '201': | |
8506 | content: | |
8507 | application/vnd.ceph.api.v1.0+json: | |
8508 | type: object | |
8509 | description: Resource created. | |
8510 | '202': | |
8511 | content: | |
8512 | application/vnd.ceph.api.v1.0+json: | |
8513 | type: object | |
8514 | description: Operation is still executing. Please check the task queue. | |
8515 | '400': | |
8516 | description: Operation exception. Please check the response body for details. | |
8517 | '401': | |
8518 | description: Unauthenticated access. Please login first. | |
8519 | '403': | |
8520 | description: Unauthorized access. Please check your permissions. | |
8521 | '500': | |
8522 | description: Unexpected error. Please check the response body for the stack | |
8523 | trace. | |
8524 | security: | |
8525 | - jwt: [] | |
8526 | tags: | |
8527 | - RgwUser | |
8528 | /api/rgw/user/{uid}/quota: | |
8529 | get: | |
8530 | parameters: | |
8531 | - in: path | |
8532 | name: uid | |
8533 | required: true | |
8534 | schema: | |
8535 | type: string | |
8536 | - allowEmptyValue: true | |
8537 | in: query | |
8538 | name: daemon_name | |
8539 | schema: | |
8540 | type: string | |
8541 | responses: | |
8542 | '200': | |
8543 | content: | |
8544 | application/vnd.ceph.api.v1.0+json: | |
8545 | type: object | |
8546 | description: OK | |
8547 | '400': | |
8548 | description: Operation exception. Please check the response body for details. | |
8549 | '401': | |
8550 | description: Unauthenticated access. Please login first. | |
8551 | '403': | |
8552 | description: Unauthorized access. Please check your permissions. | |
8553 | '500': | |
8554 | description: Unexpected error. Please check the response body for the stack | |
8555 | trace. | |
8556 | security: | |
8557 | - jwt: [] | |
8558 | tags: | |
8559 | - RgwUser | |
8560 | put: | |
8561 | parameters: | |
8562 | - in: path | |
8563 | name: uid | |
8564 | required: true | |
8565 | schema: | |
8566 | type: string | |
8567 | requestBody: | |
8568 | content: | |
8569 | application/json: | |
8570 | schema: | |
8571 | properties: | |
8572 | daemon_name: | |
8573 | type: string | |
8574 | enabled: | |
8575 | type: string | |
8576 | max_objects: | |
8577 | type: string | |
8578 | max_size_kb: | |
8579 | type: integer | |
8580 | quota_type: | |
8581 | type: string | |
8582 | required: | |
8583 | - quota_type | |
8584 | - enabled | |
8585 | - max_size_kb | |
8586 | - max_objects | |
8587 | type: object | |
8588 | responses: | |
8589 | '200': | |
8590 | content: | |
8591 | application/vnd.ceph.api.v1.0+json: | |
8592 | type: object | |
8593 | description: Resource updated. | |
8594 | '202': | |
8595 | content: | |
8596 | application/vnd.ceph.api.v1.0+json: | |
8597 | type: object | |
8598 | description: Operation is still executing. Please check the task queue. | |
8599 | '400': | |
8600 | description: Operation exception. Please check the response body for details. | |
8601 | '401': | |
8602 | description: Unauthenticated access. Please login first. | |
8603 | '403': | |
8604 | description: Unauthorized access. Please check your permissions. | |
8605 | '500': | |
8606 | description: Unexpected error. Please check the response body for the stack | |
8607 | trace. | |
8608 | security: | |
8609 | - jwt: [] | |
8610 | tags: | |
8611 | - RgwUser | |
8612 | /api/rgw/user/{uid}/subuser: | |
8613 | post: | |
8614 | parameters: | |
8615 | - in: path | |
8616 | name: uid | |
8617 | required: true | |
8618 | schema: | |
8619 | type: string | |
8620 | requestBody: | |
8621 | content: | |
8622 | application/json: | |
8623 | schema: | |
8624 | properties: | |
8625 | access: | |
8626 | type: string | |
8627 | access_key: | |
8628 | type: string | |
8629 | daemon_name: | |
8630 | type: string | |
8631 | generate_secret: | |
8632 | default: 'true' | |
8633 | type: string | |
8634 | key_type: | |
8635 | default: s3 | |
8636 | type: string | |
8637 | secret_key: | |
8638 | type: string | |
8639 | subuser: | |
8640 | type: string | |
8641 | required: | |
8642 | - subuser | |
8643 | - access | |
8644 | type: object | |
8645 | responses: | |
8646 | '201': | |
8647 | content: | |
8648 | application/vnd.ceph.api.v1.0+json: | |
8649 | type: object | |
8650 | description: Resource created. | |
8651 | '202': | |
8652 | content: | |
8653 | application/vnd.ceph.api.v1.0+json: | |
8654 | type: object | |
8655 | description: Operation is still executing. Please check the task queue. | |
8656 | '400': | |
8657 | description: Operation exception. Please check the response body for details. | |
8658 | '401': | |
8659 | description: Unauthenticated access. Please login first. | |
8660 | '403': | |
8661 | description: Unauthorized access. Please check your permissions. | |
8662 | '500': | |
8663 | description: Unexpected error. Please check the response body for the stack | |
8664 | trace. | |
8665 | security: | |
8666 | - jwt: [] | |
8667 | tags: | |
8668 | - RgwUser | |
8669 | /api/rgw/user/{uid}/subuser/{subuser}: | |
8670 | delete: | |
8671 | description: "\n :param purge_keys: Set to False to do not purge the\ | |
8672 | \ keys.\n Note, this only works for s3 subusers.\n\ | |
8673 | \ " | |
8674 | parameters: | |
8675 | - in: path | |
8676 | name: uid | |
8677 | required: true | |
8678 | schema: | |
8679 | type: string | |
8680 | - in: path | |
8681 | name: subuser | |
8682 | required: true | |
8683 | schema: | |
8684 | type: string | |
8685 | - default: 'true' | |
8686 | in: query | |
8687 | name: purge_keys | |
8688 | schema: | |
8689 | type: string | |
8690 | - allowEmptyValue: true | |
8691 | in: query | |
8692 | name: daemon_name | |
8693 | schema: | |
8694 | type: string | |
8695 | responses: | |
8696 | '202': | |
8697 | content: | |
8698 | application/vnd.ceph.api.v1.0+json: | |
8699 | type: object | |
8700 | description: Operation is still executing. Please check the task queue. | |
8701 | '204': | |
8702 | content: | |
8703 | application/vnd.ceph.api.v1.0+json: | |
8704 | type: object | |
8705 | description: Resource deleted. | |
8706 | '400': | |
8707 | description: Operation exception. Please check the response body for details. | |
8708 | '401': | |
8709 | description: Unauthenticated access. Please login first. | |
8710 | '403': | |
8711 | description: Unauthorized access. Please check your permissions. | |
8712 | '500': | |
8713 | description: Unexpected error. Please check the response body for the stack | |
8714 | trace. | |
8715 | security: | |
8716 | - jwt: [] | |
8717 | tags: | |
8718 | - RgwUser | |
8719 | /api/role: | |
8720 | get: | |
8721 | parameters: [] | |
8722 | responses: | |
8723 | '200': | |
8724 | content: | |
8725 | application/vnd.ceph.api.v1.0+json: | |
8726 | schema: | |
8727 | items: | |
8728 | properties: | |
8729 | description: | |
8730 | description: Role Descriptions | |
8731 | type: string | |
8732 | name: | |
8733 | description: Role Name | |
8734 | type: string | |
8735 | scopes_permissions: | |
8736 | description: '' | |
8737 | properties: | |
8738 | cephfs: | |
8739 | description: '' | |
8740 | items: | |
8741 | type: string | |
8742 | type: array | |
8743 | required: | |
8744 | - cephfs | |
8745 | type: object | |
8746 | system: | |
8747 | description: '' | |
8748 | type: boolean | |
8749 | type: object | |
8750 | required: | |
8751 | - name | |
8752 | - description | |
8753 | - scopes_permissions | |
8754 | - system | |
8755 | type: array | |
8756 | description: OK | |
8757 | '400': | |
8758 | description: Operation exception. Please check the response body for details. | |
8759 | '401': | |
8760 | description: Unauthenticated access. Please login first. | |
8761 | '403': | |
8762 | description: Unauthorized access. Please check your permissions. | |
8763 | '500': | |
8764 | description: Unexpected error. Please check the response body for the stack | |
8765 | trace. | |
8766 | security: | |
8767 | - jwt: [] | |
8768 | summary: Display Role list | |
8769 | tags: | |
8770 | - Role | |
8771 | post: | |
8772 | parameters: [] | |
8773 | requestBody: | |
8774 | content: | |
8775 | application/json: | |
8776 | schema: | |
8777 | properties: | |
8778 | description: | |
8779 | type: string | |
8780 | name: | |
8781 | type: string | |
8782 | scopes_permissions: | |
8783 | type: string | |
8784 | type: object | |
8785 | responses: | |
8786 | '201': | |
8787 | content: | |
8788 | application/vnd.ceph.api.v1.0+json: | |
8789 | type: object | |
8790 | description: Resource created. | |
8791 | '202': | |
8792 | content: | |
8793 | application/vnd.ceph.api.v1.0+json: | |
8794 | type: object | |
8795 | description: Operation is still executing. Please check the task queue. | |
8796 | '400': | |
8797 | description: Operation exception. Please check the response body for details. | |
8798 | '401': | |
8799 | description: Unauthenticated access. Please login first. | |
8800 | '403': | |
8801 | description: Unauthorized access. Please check your permissions. | |
8802 | '500': | |
8803 | description: Unexpected error. Please check the response body for the stack | |
8804 | trace. | |
8805 | security: | |
8806 | - jwt: [] | |
8807 | tags: | |
8808 | - Role | |
8809 | /api/role/{name}: | |
8810 | delete: | |
8811 | parameters: | |
8812 | - in: path | |
8813 | name: name | |
8814 | required: true | |
8815 | schema: | |
8816 | type: string | |
8817 | responses: | |
8818 | '202': | |
8819 | content: | |
8820 | application/vnd.ceph.api.v1.0+json: | |
8821 | type: object | |
8822 | description: Operation is still executing. Please check the task queue. | |
8823 | '204': | |
8824 | content: | |
8825 | application/vnd.ceph.api.v1.0+json: | |
8826 | type: object | |
8827 | description: Resource deleted. | |
8828 | '400': | |
8829 | description: Operation exception. Please check the response body for details. | |
8830 | '401': | |
8831 | description: Unauthenticated access. Please login first. | |
8832 | '403': | |
8833 | description: Unauthorized access. Please check your permissions. | |
8834 | '500': | |
8835 | description: Unexpected error. Please check the response body for the stack | |
8836 | trace. | |
8837 | security: | |
8838 | - jwt: [] | |
8839 | tags: | |
8840 | - Role | |
8841 | get: | |
8842 | parameters: | |
8843 | - in: path | |
8844 | name: name | |
8845 | required: true | |
8846 | schema: | |
8847 | type: string | |
8848 | responses: | |
8849 | '200': | |
8850 | content: | |
8851 | application/vnd.ceph.api.v1.0+json: | |
8852 | type: object | |
8853 | description: OK | |
8854 | '400': | |
8855 | description: Operation exception. Please check the response body for details. | |
8856 | '401': | |
8857 | description: Unauthenticated access. Please login first. | |
8858 | '403': | |
8859 | description: Unauthorized access. Please check your permissions. | |
8860 | '500': | |
8861 | description: Unexpected error. Please check the response body for the stack | |
8862 | trace. | |
8863 | security: | |
8864 | - jwt: [] | |
8865 | tags: | |
8866 | - Role | |
8867 | put: | |
8868 | parameters: | |
8869 | - in: path | |
8870 | name: name | |
8871 | required: true | |
8872 | schema: | |
8873 | type: string | |
8874 | requestBody: | |
8875 | content: | |
8876 | application/json: | |
8877 | schema: | |
8878 | properties: | |
8879 | description: | |
8880 | type: string | |
8881 | scopes_permissions: | |
8882 | type: string | |
8883 | type: object | |
8884 | responses: | |
8885 | '200': | |
8886 | content: | |
8887 | application/vnd.ceph.api.v1.0+json: | |
8888 | type: object | |
8889 | description: Resource updated. | |
8890 | '202': | |
8891 | content: | |
8892 | application/vnd.ceph.api.v1.0+json: | |
8893 | type: object | |
8894 | description: Operation is still executing. Please check the task queue. | |
8895 | '400': | |
8896 | description: Operation exception. Please check the response body for details. | |
8897 | '401': | |
8898 | description: Unauthenticated access. Please login first. | |
8899 | '403': | |
8900 | description: Unauthorized access. Please check your permissions. | |
8901 | '500': | |
8902 | description: Unexpected error. Please check the response body for the stack | |
8903 | trace. | |
8904 | security: | |
8905 | - jwt: [] | |
8906 | tags: | |
8907 | - Role | |
8908 | /api/role/{name}/clone: | |
8909 | post: | |
8910 | parameters: | |
8911 | - in: path | |
8912 | name: name | |
8913 | required: true | |
8914 | schema: | |
8915 | type: string | |
8916 | requestBody: | |
8917 | content: | |
8918 | application/json: | |
8919 | schema: | |
8920 | properties: | |
8921 | new_name: | |
8922 | type: string | |
8923 | required: | |
8924 | - new_name | |
8925 | type: object | |
8926 | responses: | |
8927 | '201': | |
8928 | content: | |
8929 | application/vnd.ceph.api.v1.0+json: | |
8930 | type: object | |
8931 | description: Resource created. | |
8932 | '202': | |
8933 | content: | |
8934 | application/vnd.ceph.api.v1.0+json: | |
8935 | type: object | |
8936 | description: Operation is still executing. Please check the task queue. | |
8937 | '400': | |
8938 | description: Operation exception. Please check the response body for details. | |
8939 | '401': | |
8940 | description: Unauthenticated access. Please login first. | |
8941 | '403': | |
8942 | description: Unauthorized access. Please check your permissions. | |
8943 | '500': | |
8944 | description: Unexpected error. Please check the response body for the stack | |
8945 | trace. | |
8946 | security: | |
8947 | - jwt: [] | |
8948 | tags: | |
8949 | - Role | |
8950 | /api/service: | |
8951 | get: | |
8952 | parameters: | |
8953 | - allowEmptyValue: true | |
8954 | in: query | |
8955 | name: service_name | |
8956 | schema: | |
8957 | type: string | |
39ae355f TL |
8958 | - default: 0 |
8959 | in: query | |
8960 | name: offset | |
8961 | schema: | |
8962 | type: integer | |
8963 | - default: 5 | |
8964 | in: query | |
8965 | name: limit | |
8966 | schema: | |
8967 | type: integer | |
8968 | - default: '' | |
8969 | in: query | |
8970 | name: search | |
8971 | schema: | |
8972 | type: string | |
8973 | - default: +service_name | |
8974 | in: query | |
8975 | name: sort | |
8976 | schema: | |
8977 | type: string | |
f67539c2 TL |
8978 | responses: |
8979 | '200': | |
8980 | content: | |
39ae355f | 8981 | application/vnd.ceph.api.v2.0+json: |
f67539c2 TL |
8982 | type: object |
8983 | description: OK | |
8984 | '400': | |
8985 | description: Operation exception. Please check the response body for details. | |
8986 | '401': | |
8987 | description: Unauthenticated access. Please login first. | |
8988 | '403': | |
8989 | description: Unauthorized access. Please check your permissions. | |
8990 | '500': | |
8991 | description: Unexpected error. Please check the response body for the stack | |
8992 | trace. | |
8993 | security: | |
8994 | - jwt: [] | |
8995 | tags: | |
8996 | - Service | |
8997 | post: | |
8998 | description: "\n :param service_spec: The service specification as JSON.\n\ | |
8999 | \ :param service_name: The service name, e.g. 'alertmanager'.\n \ | |
9000 | \ :return: None\n " | |
9001 | parameters: [] | |
9002 | requestBody: | |
9003 | content: | |
9004 | application/json: | |
9005 | schema: | |
9006 | properties: | |
9007 | service_name: | |
9008 | type: string | |
9009 | service_spec: | |
9010 | type: string | |
9011 | required: | |
9012 | - service_spec | |
9013 | - service_name | |
9014 | type: object | |
9015 | responses: | |
9016 | '201': | |
9017 | content: | |
9018 | application/vnd.ceph.api.v1.0+json: | |
9019 | type: object | |
9020 | description: Resource created. | |
9021 | '202': | |
9022 | content: | |
9023 | application/vnd.ceph.api.v1.0+json: | |
9024 | type: object | |
9025 | description: Operation is still executing. Please check the task queue. | |
9026 | '400': | |
9027 | description: Operation exception. Please check the response body for details. | |
9028 | '401': | |
9029 | description: Unauthenticated access. Please login first. | |
9030 | '403': | |
9031 | description: Unauthorized access. Please check your permissions. | |
9032 | '500': | |
9033 | description: Unexpected error. Please check the response body for the stack | |
9034 | trace. | |
9035 | security: | |
9036 | - jwt: [] | |
9037 | tags: | |
9038 | - Service | |
9039 | /api/service/known_types: | |
9040 | get: | |
9041 | description: "\n Get a list of known service types, e.g. 'alertmanager',\n\ | |
9042 | \ 'node-exporter', 'osd' or 'rgw'.\n " | |
9043 | parameters: [] | |
9044 | responses: | |
9045 | '200': | |
9046 | content: | |
9047 | application/vnd.ceph.api.v1.0+json: | |
9048 | type: object | |
9049 | description: OK | |
9050 | '400': | |
9051 | description: Operation exception. Please check the response body for details. | |
9052 | '401': | |
9053 | description: Unauthenticated access. Please login first. | |
9054 | '403': | |
9055 | description: Unauthorized access. Please check your permissions. | |
9056 | '500': | |
9057 | description: Unexpected error. Please check the response body for the stack | |
9058 | trace. | |
9059 | security: | |
9060 | - jwt: [] | |
9061 | tags: | |
9062 | - Service | |
9063 | /api/service/{service_name}: | |
9064 | delete: | |
9065 | description: "\n :param service_name: The service name, e.g. 'mds' or\ | |
9066 | \ 'crash.foo'.\n :return: None\n " | |
9067 | parameters: | |
9068 | - in: path | |
9069 | name: service_name | |
9070 | required: true | |
9071 | schema: | |
9072 | type: string | |
9073 | responses: | |
9074 | '202': | |
9075 | content: | |
9076 | application/vnd.ceph.api.v1.0+json: | |
9077 | type: object | |
9078 | description: Operation is still executing. Please check the task queue. | |
9079 | '204': | |
9080 | content: | |
9081 | application/vnd.ceph.api.v1.0+json: | |
9082 | type: object | |
9083 | description: Resource deleted. | |
9084 | '400': | |
9085 | description: Operation exception. Please check the response body for details. | |
9086 | '401': | |
9087 | description: Unauthenticated access. Please login first. | |
9088 | '403': | |
9089 | description: Unauthorized access. Please check your permissions. | |
9090 | '500': | |
9091 | description: Unexpected error. Please check the response body for the stack | |
9092 | trace. | |
9093 | security: | |
9094 | - jwt: [] | |
9095 | tags: | |
9096 | - Service | |
9097 | get: | |
9098 | parameters: | |
9099 | - in: path | |
9100 | name: service_name | |
9101 | required: true | |
9102 | schema: | |
9103 | type: string | |
9104 | responses: | |
9105 | '200': | |
9106 | content: | |
9107 | application/vnd.ceph.api.v1.0+json: | |
9108 | type: object | |
9109 | description: OK | |
9110 | '400': | |
9111 | description: Operation exception. Please check the response body for details. | |
9112 | '401': | |
9113 | description: Unauthenticated access. Please login first. | |
9114 | '403': | |
9115 | description: Unauthorized access. Please check your permissions. | |
9116 | '500': | |
9117 | description: Unexpected error. Please check the response body for the stack | |
9118 | trace. | |
9119 | security: | |
9120 | - jwt: [] | |
9121 | tags: | |
9122 | - Service | |
2a845540 TL |
9123 | put: |
9124 | description: "\n :param service_spec: The service specification as JSON.\n\ | |
9125 | \ :param service_name: The service name, e.g. 'alertmanager'.\n \ | |
9126 | \ :return: None\n " | |
9127 | parameters: | |
9128 | - in: path | |
9129 | name: service_name | |
9130 | required: true | |
9131 | schema: | |
9132 | type: string | |
9133 | requestBody: | |
9134 | content: | |
9135 | application/json: | |
9136 | schema: | |
9137 | properties: | |
9138 | service_spec: | |
9139 | type: string | |
9140 | required: | |
9141 | - service_spec | |
9142 | type: object | |
9143 | responses: | |
9144 | '200': | |
9145 | content: | |
9146 | application/vnd.ceph.api.v1.0+json: | |
9147 | type: object | |
9148 | description: Resource updated. | |
9149 | '202': | |
9150 | content: | |
9151 | application/vnd.ceph.api.v1.0+json: | |
9152 | type: object | |
9153 | description: Operation is still executing. Please check the task queue. | |
9154 | '400': | |
9155 | description: Operation exception. Please check the response body for details. | |
9156 | '401': | |
9157 | description: Unauthenticated access. Please login first. | |
9158 | '403': | |
9159 | description: Unauthorized access. Please check your permissions. | |
9160 | '500': | |
9161 | description: Unexpected error. Please check the response body for the stack | |
9162 | trace. | |
9163 | security: | |
9164 | - jwt: [] | |
9165 | tags: | |
9166 | - Service | |
f67539c2 TL |
9167 | /api/service/{service_name}/daemons: |
9168 | get: | |
9169 | parameters: | |
9170 | - in: path | |
9171 | name: service_name | |
9172 | required: true | |
9173 | schema: | |
9174 | type: string | |
9175 | responses: | |
9176 | '200': | |
9177 | content: | |
9178 | application/vnd.ceph.api.v1.0+json: | |
9179 | type: object | |
9180 | description: OK | |
9181 | '400': | |
9182 | description: Operation exception. Please check the response body for details. | |
9183 | '401': | |
9184 | description: Unauthenticated access. Please login first. | |
9185 | '403': | |
9186 | description: Unauthorized access. Please check your permissions. | |
9187 | '500': | |
9188 | description: Unexpected error. Please check the response body for the stack | |
9189 | trace. | |
9190 | security: | |
9191 | - jwt: [] | |
9192 | tags: | |
9193 | - Service | |
9194 | /api/settings: | |
9195 | get: | |
9196 | description: "\n Get the list of available options.\n :param names:\ | |
9197 | \ A comma separated list of option names that should\n be processed.\ | |
9198 | \ Defaults to ``None``.\n :type names: None|str\n :return: A\ | |
9199 | \ list of available options.\n :rtype: list[dict]\n " | |
9200 | parameters: | |
9201 | - allowEmptyValue: true | |
9202 | description: Name of Settings | |
9203 | in: query | |
9204 | name: names | |
9205 | schema: | |
9206 | type: string | |
9207 | responses: | |
9208 | '200': | |
9209 | content: | |
9210 | application/vnd.ceph.api.v1.0+json: | |
9211 | schema: | |
9212 | items: | |
9213 | properties: | |
9214 | default: | |
9215 | description: Default Settings | |
9216 | type: boolean | |
9217 | name: | |
9218 | description: Settings Name | |
9219 | type: string | |
9220 | type: | |
9221 | description: Type of Settings | |
9222 | type: string | |
9223 | value: | |
9224 | description: Settings Value | |
9225 | type: boolean | |
9226 | type: object | |
9227 | required: | |
9228 | - name | |
9229 | - default | |
9230 | - type | |
9231 | - value | |
9232 | type: array | |
9233 | description: OK | |
9234 | '400': | |
9235 | description: Operation exception. Please check the response body for details. | |
9236 | '401': | |
9237 | description: Unauthenticated access. Please login first. | |
9238 | '403': | |
9239 | description: Unauthorized access. Please check your permissions. | |
9240 | '500': | |
9241 | description: Unexpected error. Please check the response body for the stack | |
9242 | trace. | |
9243 | security: | |
9244 | - jwt: [] | |
9245 | summary: Display Settings Information | |
9246 | tags: | |
9247 | - Settings | |
9248 | put: | |
9249 | parameters: [] | |
9250 | responses: | |
9251 | '200': | |
9252 | content: | |
9253 | application/vnd.ceph.api.v1.0+json: | |
9254 | type: object | |
9255 | description: Resource updated. | |
9256 | '202': | |
9257 | content: | |
9258 | application/vnd.ceph.api.v1.0+json: | |
9259 | type: object | |
9260 | description: Operation is still executing. Please check the task queue. | |
9261 | '400': | |
9262 | description: Operation exception. Please check the response body for details. | |
9263 | '401': | |
9264 | description: Unauthenticated access. Please login first. | |
9265 | '403': | |
9266 | description: Unauthorized access. Please check your permissions. | |
9267 | '500': | |
9268 | description: Unexpected error. Please check the response body for the stack | |
9269 | trace. | |
9270 | security: | |
9271 | - jwt: [] | |
9272 | tags: | |
9273 | - Settings | |
9274 | /api/settings/{name}: | |
9275 | delete: | |
9276 | parameters: | |
9277 | - in: path | |
9278 | name: name | |
9279 | required: true | |
9280 | schema: | |
9281 | type: string | |
9282 | responses: | |
9283 | '202': | |
9284 | content: | |
9285 | application/vnd.ceph.api.v1.0+json: | |
9286 | type: object | |
9287 | description: Operation is still executing. Please check the task queue. | |
9288 | '204': | |
9289 | content: | |
9290 | application/vnd.ceph.api.v1.0+json: | |
9291 | type: object | |
9292 | description: Resource deleted. | |
9293 | '400': | |
9294 | description: Operation exception. Please check the response body for details. | |
9295 | '401': | |
9296 | description: Unauthenticated access. Please login first. | |
9297 | '403': | |
9298 | description: Unauthorized access. Please check your permissions. | |
9299 | '500': | |
9300 | description: Unexpected error. Please check the response body for the stack | |
9301 | trace. | |
9302 | security: | |
9303 | - jwt: [] | |
9304 | tags: | |
9305 | - Settings | |
9306 | get: | |
9307 | description: "\n Get the given option.\n :param name: The name\ | |
9308 | \ of the option.\n :return: Returns a dict containing the name, type,\n\ | |
9309 | \ default value and current value of the given option.\n :rtype:\ | |
9310 | \ dict\n " | |
9311 | parameters: | |
9312 | - in: path | |
9313 | name: name | |
9314 | required: true | |
9315 | schema: | |
9316 | type: string | |
9317 | responses: | |
9318 | '200': | |
9319 | content: | |
9320 | application/vnd.ceph.api.v1.0+json: | |
9321 | type: object | |
9322 | description: OK | |
9323 | '400': | |
9324 | description: Operation exception. Please check the response body for details. | |
9325 | '401': | |
9326 | description: Unauthenticated access. Please login first. | |
9327 | '403': | |
9328 | description: Unauthorized access. Please check your permissions. | |
9329 | '500': | |
9330 | description: Unexpected error. Please check the response body for the stack | |
9331 | trace. | |
9332 | security: | |
9333 | - jwt: [] | |
9334 | tags: | |
9335 | - Settings | |
9336 | put: | |
9337 | parameters: | |
9338 | - in: path | |
9339 | name: name | |
9340 | required: true | |
9341 | schema: | |
9342 | type: string | |
9343 | requestBody: | |
9344 | content: | |
9345 | application/json: | |
9346 | schema: | |
9347 | properties: | |
9348 | value: | |
9349 | type: string | |
9350 | required: | |
9351 | - value | |
9352 | type: object | |
9353 | responses: | |
9354 | '200': | |
9355 | content: | |
9356 | application/vnd.ceph.api.v1.0+json: | |
9357 | type: object | |
9358 | description: Resource updated. | |
9359 | '202': | |
9360 | content: | |
9361 | application/vnd.ceph.api.v1.0+json: | |
9362 | type: object | |
9363 | description: Operation is still executing. Please check the task queue. | |
9364 | '400': | |
9365 | description: Operation exception. Please check the response body for details. | |
9366 | '401': | |
9367 | description: Unauthenticated access. Please login first. | |
9368 | '403': | |
9369 | description: Unauthorized access. Please check your permissions. | |
9370 | '500': | |
9371 | description: Unexpected error. Please check the response body for the stack | |
9372 | trace. | |
9373 | security: | |
9374 | - jwt: [] | |
9375 | tags: | |
9376 | - Settings | |
9377 | /api/summary: | |
9378 | get: | |
9379 | parameters: [] | |
9380 | responses: | |
9381 | '200': | |
9382 | content: | |
9383 | application/vnd.ceph.api.v1.0+json: | |
9384 | schema: | |
9385 | properties: | |
9386 | executing_tasks: | |
9387 | description: '' | |
9388 | items: | |
9389 | type: string | |
9390 | type: array | |
9391 | finished_tasks: | |
9392 | description: '' | |
9393 | items: | |
9394 | properties: | |
9395 | begin_time: | |
9396 | description: '' | |
9397 | type: string | |
9398 | duration: | |
9399 | description: '' | |
9400 | type: integer | |
9401 | end_time: | |
9402 | description: '' | |
9403 | type: string | |
9404 | exception: | |
9405 | description: '' | |
9406 | type: string | |
9407 | metadata: | |
9408 | description: '' | |
9409 | properties: | |
9410 | pool: | |
9411 | description: '' | |
9412 | type: integer | |
9413 | required: | |
9414 | - pool | |
9415 | type: object | |
9416 | name: | |
9417 | description: '' | |
9418 | type: string | |
9419 | progress: | |
9420 | description: '' | |
9421 | type: integer | |
9422 | ret_value: | |
9423 | description: '' | |
9424 | type: string | |
9425 | success: | |
9426 | description: '' | |
9427 | type: boolean | |
9428 | required: | |
9429 | - name | |
9430 | - metadata | |
9431 | - begin_time | |
9432 | - end_time | |
9433 | - duration | |
9434 | - progress | |
9435 | - success | |
9436 | - ret_value | |
9437 | - exception | |
9438 | type: object | |
9439 | type: array | |
9440 | have_mon_connection: | |
9441 | description: '' | |
9442 | type: string | |
9443 | health_status: | |
9444 | description: '' | |
9445 | type: string | |
9446 | mgr_host: | |
9447 | description: '' | |
9448 | type: string | |
9449 | mgr_id: | |
9450 | description: '' | |
9451 | type: string | |
9452 | rbd_mirroring: | |
9453 | description: '' | |
9454 | properties: | |
9455 | errors: | |
9456 | description: '' | |
9457 | type: integer | |
9458 | warnings: | |
9459 | description: '' | |
9460 | type: integer | |
9461 | required: | |
9462 | - warnings | |
9463 | - errors | |
9464 | type: object | |
9465 | version: | |
9466 | description: '' | |
9467 | type: string | |
9468 | required: | |
9469 | - health_status | |
9470 | - mgr_id | |
9471 | - mgr_host | |
9472 | - have_mon_connection | |
9473 | - executing_tasks | |
9474 | - finished_tasks | |
9475 | - version | |
9476 | - rbd_mirroring | |
9477 | type: object | |
9478 | description: OK | |
9479 | '400': | |
9480 | description: Operation exception. Please check the response body for details. | |
9481 | '401': | |
9482 | description: Unauthenticated access. Please login first. | |
9483 | '403': | |
9484 | description: Unauthorized access. Please check your permissions. | |
9485 | '500': | |
9486 | description: Unexpected error. Please check the response body for the stack | |
9487 | trace. | |
9488 | security: | |
9489 | - jwt: [] | |
9490 | summary: Display Summary | |
9491 | tags: | |
9492 | - Summary | |
9493 | /api/task: | |
9494 | get: | |
9495 | parameters: | |
9496 | - allowEmptyValue: true | |
9497 | description: Task Name | |
9498 | in: query | |
9499 | name: name | |
9500 | schema: | |
9501 | type: string | |
9502 | responses: | |
9503 | '200': | |
9504 | content: | |
9505 | application/vnd.ceph.api.v1.0+json: | |
9506 | schema: | |
9507 | properties: | |
9508 | executing_tasks: | |
9509 | description: ongoing executing tasks | |
9510 | type: string | |
9511 | finished_tasks: | |
9512 | description: '' | |
9513 | items: | |
9514 | properties: | |
9515 | begin_time: | |
9516 | description: Task begin time | |
9517 | type: string | |
9518 | duration: | |
9519 | description: '' | |
9520 | type: integer | |
9521 | end_time: | |
9522 | description: Task end time | |
9523 | type: string | |
9524 | exception: | |
9525 | description: '' | |
9526 | type: boolean | |
9527 | metadata: | |
9528 | description: '' | |
9529 | properties: | |
9530 | pool: | |
9531 | description: '' | |
9532 | type: integer | |
9533 | required: | |
9534 | - pool | |
9535 | type: object | |
9536 | name: | |
9537 | description: finished tasks name | |
9538 | type: string | |
9539 | progress: | |
9540 | description: Progress of tasks | |
9541 | type: integer | |
9542 | ret_value: | |
9543 | description: '' | |
9544 | type: boolean | |
9545 | success: | |
9546 | description: '' | |
9547 | type: boolean | |
9548 | required: | |
9549 | - name | |
9550 | - metadata | |
9551 | - begin_time | |
9552 | - end_time | |
9553 | - duration | |
9554 | - progress | |
9555 | - success | |
9556 | - ret_value | |
9557 | - exception | |
9558 | type: object | |
9559 | type: array | |
9560 | required: | |
9561 | - executing_tasks | |
9562 | - finished_tasks | |
9563 | type: object | |
9564 | description: OK | |
9565 | '400': | |
9566 | description: Operation exception. Please check the response body for details. | |
9567 | '401': | |
9568 | description: Unauthenticated access. Please login first. | |
9569 | '403': | |
9570 | description: Unauthorized access. Please check your permissions. | |
9571 | '500': | |
9572 | description: Unexpected error. Please check the response body for the stack | |
9573 | trace. | |
9574 | security: | |
9575 | - jwt: [] | |
9576 | summary: Display Tasks | |
9577 | tags: | |
9578 | - Task | |
9579 | /api/telemetry: | |
9580 | put: | |
9581 | description: "\n Enables or disables sending data collected by the Telemetry\n\ | |
9582 | \ module.\n :param enable: Enable or disable sending data\n\ | |
9583 | \ :type enable: bool\n :param license_name: License string e.g.\ | |
9584 | \ 'sharing-1-0' to\n make sure the user is aware of and accepts the\ | |
9585 | \ license\n for sharing Telemetry data.\n :type license_name:\ | |
9586 | \ string\n " | |
9587 | parameters: [] | |
9588 | requestBody: | |
9589 | content: | |
9590 | application/json: | |
9591 | schema: | |
9592 | properties: | |
9593 | enable: | |
9594 | default: true | |
9595 | type: boolean | |
9596 | license_name: | |
9597 | type: string | |
9598 | type: object | |
9599 | responses: | |
9600 | '200': | |
9601 | content: | |
9602 | application/vnd.ceph.api.v1.0+json: | |
9603 | type: object | |
9604 | description: Resource updated. | |
9605 | '202': | |
9606 | content: | |
9607 | application/vnd.ceph.api.v1.0+json: | |
9608 | type: object | |
9609 | description: Operation is still executing. Please check the task queue. | |
9610 | '400': | |
9611 | description: Operation exception. Please check the response body for details. | |
9612 | '401': | |
9613 | description: Unauthenticated access. Please login first. | |
9614 | '403': | |
9615 | description: Unauthorized access. Please check your permissions. | |
9616 | '500': | |
9617 | description: Unexpected error. Please check the response body for the stack | |
9618 | trace. | |
9619 | security: | |
9620 | - jwt: [] | |
9621 | tags: | |
9622 | - Telemetry | |
9623 | /api/telemetry/report: | |
9624 | get: | |
9625 | description: "\n Get Ceph and device report data\n :return: Ceph\ | |
9626 | \ and device report data\n :rtype: dict\n " | |
9627 | parameters: [] | |
9628 | responses: | |
9629 | '200': | |
9630 | content: | |
9631 | application/vnd.ceph.api.v1.0+json: | |
9632 | schema: | |
9633 | properties: | |
9634 | device_report: | |
9635 | description: '' | |
9636 | type: string | |
9637 | report: | |
9638 | description: '' | |
9639 | properties: | |
9640 | balancer: | |
9641 | description: '' | |
9642 | properties: | |
9643 | active: | |
9644 | description: '' | |
9645 | type: boolean | |
9646 | mode: | |
9647 | description: '' | |
9648 | type: string | |
9649 | required: | |
9650 | - active | |
9651 | - mode | |
9652 | type: object | |
9653 | channels: | |
9654 | description: '' | |
9655 | items: | |
9656 | type: string | |
9657 | type: array | |
9658 | channels_available: | |
9659 | description: '' | |
9660 | items: | |
9661 | type: string | |
9662 | type: array | |
9663 | config: | |
9664 | description: '' | |
9665 | properties: | |
9666 | active_changed: | |
9667 | description: '' | |
9668 | items: | |
9669 | type: string | |
9670 | type: array | |
9671 | cluster_changed: | |
9672 | description: '' | |
9673 | items: | |
9674 | type: string | |
9675 | type: array | |
9676 | required: | |
9677 | - cluster_changed | |
9678 | - active_changed | |
9679 | type: object | |
9680 | crashes: | |
9681 | description: '' | |
9682 | items: | |
9683 | type: integer | |
9684 | type: array | |
9685 | created: | |
9686 | description: '' | |
9687 | type: string | |
9688 | crush: | |
9689 | description: '' | |
9690 | properties: | |
9691 | bucket_algs: | |
9692 | description: '' | |
9693 | properties: | |
9694 | straw2: | |
9695 | description: '' | |
9696 | type: integer | |
9697 | required: | |
9698 | - straw2 | |
9699 | type: object | |
9700 | bucket_sizes: | |
9701 | description: '' | |
9702 | properties: | |
9703 | '1': | |
9704 | description: '' | |
9705 | type: integer | |
9706 | '3': | |
9707 | description: '' | |
9708 | type: integer | |
9709 | required: | |
9710 | - '1' | |
9711 | - '3' | |
9712 | type: object | |
9713 | bucket_types: | |
9714 | description: '' | |
9715 | properties: | |
9716 | '1': | |
9717 | description: '' | |
9718 | type: integer | |
9719 | '11': | |
9720 | description: '' | |
9721 | type: integer | |
9722 | required: | |
9723 | - '1' | |
9724 | - '11' | |
9725 | type: object | |
9726 | compat_weight_set: | |
9727 | description: '' | |
9728 | type: boolean | |
9729 | device_classes: | |
9730 | description: '' | |
9731 | items: | |
9732 | type: integer | |
9733 | type: array | |
9734 | num_buckets: | |
9735 | description: '' | |
9736 | type: integer | |
9737 | num_devices: | |
9738 | description: '' | |
9739 | type: integer | |
9740 | num_rules: | |
9741 | description: '' | |
9742 | type: integer | |
9743 | num_types: | |
9744 | description: '' | |
9745 | type: integer | |
9746 | num_weight_sets: | |
9747 | description: '' | |
9748 | type: integer | |
9749 | tunables: | |
9750 | description: '' | |
9751 | properties: | |
9752 | allowed_bucket_algs: | |
9753 | description: '' | |
9754 | type: integer | |
9755 | choose_local_fallback_tries: | |
9756 | description: '' | |
9757 | type: integer | |
9758 | choose_local_tries: | |
9759 | description: '' | |
9760 | type: integer | |
9761 | choose_total_tries: | |
9762 | description: '' | |
9763 | type: integer | |
9764 | chooseleaf_descend_once: | |
9765 | description: '' | |
9766 | type: integer | |
9767 | chooseleaf_stable: | |
9768 | description: '' | |
9769 | type: integer | |
9770 | chooseleaf_vary_r: | |
9771 | description: '' | |
9772 | type: integer | |
9773 | has_v2_rules: | |
9774 | description: '' | |
9775 | type: integer | |
9776 | has_v3_rules: | |
9777 | description: '' | |
9778 | type: integer | |
9779 | has_v4_buckets: | |
9780 | description: '' | |
9781 | type: integer | |
9782 | has_v5_rules: | |
9783 | description: '' | |
9784 | type: integer | |
9785 | legacy_tunables: | |
9786 | description: '' | |
9787 | type: integer | |
9788 | minimum_required_version: | |
9789 | description: '' | |
9790 | type: string | |
9791 | optimal_tunables: | |
9792 | description: '' | |
9793 | type: integer | |
9794 | profile: | |
9795 | description: '' | |
9796 | type: string | |
9797 | require_feature_tunables: | |
9798 | description: '' | |
9799 | type: integer | |
9800 | require_feature_tunables2: | |
9801 | description: '' | |
9802 | type: integer | |
9803 | require_feature_tunables3: | |
9804 | description: '' | |
9805 | type: integer | |
9806 | require_feature_tunables5: | |
9807 | description: '' | |
9808 | type: integer | |
9809 | straw_calc_version: | |
9810 | description: '' | |
9811 | type: integer | |
9812 | required: | |
9813 | - choose_local_tries | |
9814 | - choose_local_fallback_tries | |
9815 | - choose_total_tries | |
9816 | - chooseleaf_descend_once | |
9817 | - chooseleaf_vary_r | |
9818 | - chooseleaf_stable | |
9819 | - straw_calc_version | |
9820 | - allowed_bucket_algs | |
9821 | - profile | |
9822 | - optimal_tunables | |
9823 | - legacy_tunables | |
9824 | - minimum_required_version | |
9825 | - require_feature_tunables | |
9826 | - require_feature_tunables2 | |
9827 | - has_v2_rules | |
9828 | - require_feature_tunables3 | |
9829 | - has_v3_rules | |
9830 | - has_v4_buckets | |
9831 | - require_feature_tunables5 | |
9832 | - has_v5_rules | |
9833 | type: object | |
9834 | required: | |
9835 | - num_devices | |
9836 | - num_types | |
9837 | - num_buckets | |
9838 | - num_rules | |
9839 | - device_classes | |
9840 | - tunables | |
9841 | - compat_weight_set | |
9842 | - num_weight_sets | |
9843 | - bucket_algs | |
9844 | - bucket_sizes | |
9845 | - bucket_types | |
9846 | type: object | |
9847 | fs: | |
9848 | description: '' | |
9849 | properties: | |
9850 | count: | |
9851 | description: '' | |
9852 | type: integer | |
9853 | feature_flags: | |
9854 | description: '' | |
9855 | properties: | |
9856 | enable_multiple: | |
9857 | description: '' | |
9858 | type: boolean | |
9859 | ever_enabled_multiple: | |
9860 | description: '' | |
9861 | type: boolean | |
9862 | required: | |
9863 | - enable_multiple | |
9864 | - ever_enabled_multiple | |
9865 | type: object | |
9866 | filesystems: | |
9867 | description: '' | |
9868 | items: | |
9869 | type: integer | |
9870 | type: array | |
9871 | num_standby_mds: | |
9872 | description: '' | |
9873 | type: integer | |
9874 | total_num_mds: | |
9875 | description: '' | |
9876 | type: integer | |
9877 | required: | |
9878 | - count | |
9879 | - feature_flags | |
9880 | - num_standby_mds | |
9881 | - filesystems | |
9882 | - total_num_mds | |
9883 | type: object | |
9884 | hosts: | |
9885 | description: '' | |
9886 | properties: | |
9887 | num: | |
9888 | description: '' | |
9889 | type: integer | |
9890 | num_with_mds: | |
9891 | description: '' | |
9892 | type: integer | |
9893 | num_with_mgr: | |
9894 | description: '' | |
9895 | type: integer | |
9896 | num_with_mon: | |
9897 | description: '' | |
9898 | type: integer | |
9899 | num_with_osd: | |
9900 | description: '' | |
9901 | type: integer | |
9902 | required: | |
9903 | - num | |
9904 | - num_with_mon | |
9905 | - num_with_mds | |
9906 | - num_with_osd | |
9907 | - num_with_mgr | |
9908 | type: object | |
9909 | leaderboard: | |
9910 | description: '' | |
9911 | type: boolean | |
9912 | license: | |
9913 | description: '' | |
9914 | type: string | |
9915 | metadata: | |
9916 | description: '' | |
9917 | properties: | |
9918 | mon: | |
9919 | description: '' | |
9920 | properties: | |
9921 | arch: | |
9922 | description: '' | |
9923 | properties: | |
9924 | x86_64: | |
9925 | description: '' | |
9926 | type: integer | |
9927 | required: | |
9928 | - x86_64 | |
9929 | type: object | |
9930 | ceph_version: | |
9931 | description: '' | |
9932 | properties: | |
9933 | ceph version 16.0.0-3151-gf202994fcf: | |
9934 | description: '' | |
9935 | type: integer | |
9936 | required: | |
9937 | - ceph version 16.0.0-3151-gf202994fcf | |
9938 | type: object | |
9939 | cpu: | |
9940 | description: '' | |
9941 | properties: | |
9942 | Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: | |
9943 | description: '' | |
9944 | type: integer | |
9945 | required: | |
9946 | - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz | |
9947 | type: object | |
9948 | distro: | |
9949 | description: '' | |
9950 | properties: | |
9951 | centos: | |
9952 | description: '' | |
9953 | type: integer | |
9954 | required: | |
9955 | - centos | |
9956 | type: object | |
9957 | distro_description: | |
9958 | description: '' | |
9959 | properties: | |
9960 | CentOS Linux 8 (Core): | |
9961 | description: '' | |
9962 | type: integer | |
9963 | required: | |
9964 | - CentOS Linux 8 (Core) | |
9965 | type: object | |
9966 | kernel_description: | |
9967 | description: '' | |
9968 | properties: | |
9969 | '#1 SMP Wed Jul 1 19:53:01 UTC 2020': | |
9970 | description: '' | |
9971 | type: integer | |
9972 | required: | |
9973 | - '#1 SMP Wed Jul 1 19:53:01 UTC 2020' | |
9974 | type: object | |
9975 | kernel_version: | |
9976 | description: '' | |
9977 | properties: | |
9978 | 5.7.7-200.fc32.x86_64: | |
9979 | description: '' | |
9980 | type: integer | |
9981 | required: | |
9982 | - 5.7.7-200.fc32.x86_64 | |
9983 | type: object | |
9984 | os: | |
9985 | description: '' | |
9986 | properties: | |
9987 | Linux: | |
9988 | description: '' | |
9989 | type: integer | |
9990 | required: | |
9991 | - Linux | |
9992 | type: object | |
9993 | required: | |
9994 | - arch | |
9995 | - ceph_version | |
9996 | - os | |
9997 | - cpu | |
9998 | - kernel_description | |
9999 | - kernel_version | |
10000 | - distro_description | |
10001 | - distro | |
10002 | type: object | |
10003 | osd: | |
10004 | description: '' | |
10005 | properties: | |
10006 | arch: | |
10007 | description: '' | |
10008 | properties: | |
10009 | x86_64: | |
10010 | description: '' | |
10011 | type: integer | |
10012 | required: | |
10013 | - x86_64 | |
10014 | type: object | |
10015 | ceph_version: | |
10016 | description: '' | |
10017 | properties: | |
10018 | ceph version 16.0.0-3151-gf202994fcf: | |
10019 | description: '' | |
10020 | type: integer | |
10021 | required: | |
10022 | - ceph version 16.0.0-3151-gf202994fcf | |
10023 | type: object | |
10024 | cpu: | |
10025 | description: '' | |
10026 | properties: | |
10027 | Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz: | |
10028 | description: '' | |
10029 | type: integer | |
10030 | required: | |
10031 | - Intel(R) Core(TM) i7-8665U CPU @ 1.90GHz | |
10032 | type: object | |
10033 | distro: | |
10034 | description: '' | |
10035 | properties: | |
10036 | centos: | |
10037 | description: '' | |
10038 | type: integer | |
10039 | required: | |
10040 | - centos | |
10041 | type: object | |
10042 | distro_description: | |
10043 | description: '' | |
10044 | properties: | |
10045 | CentOS Linux 8 (Core): | |
10046 | description: '' | |
10047 | type: integer | |
10048 | required: | |
10049 | - CentOS Linux 8 (Core) | |
10050 | type: object | |
10051 | kernel_description: | |
10052 | description: '' | |
10053 | properties: | |
10054 | '#1 SMP Wed Jul 1 19:53:01 UTC 2020': | |
10055 | description: '' | |
10056 | type: integer | |
10057 | required: | |
10058 | - '#1 SMP Wed Jul 1 19:53:01 UTC 2020' | |
10059 | type: object | |
10060 | kernel_version: | |
10061 | description: '' | |
10062 | properties: | |
10063 | 5.7.7-200.fc32.x86_64: | |
10064 | description: '' | |
10065 | type: integer | |
10066 | required: | |
10067 | - 5.7.7-200.fc32.x86_64 | |
10068 | type: object | |
10069 | os: | |
10070 | description: '' | |
10071 | properties: | |
10072 | Linux: | |
10073 | description: '' | |
10074 | type: integer | |
10075 | required: | |
10076 | - Linux | |
10077 | type: object | |
10078 | osd_objectstore: | |
10079 | description: '' | |
10080 | properties: | |
10081 | bluestore: | |
10082 | description: '' | |
10083 | type: integer | |
10084 | required: | |
10085 | - bluestore | |
10086 | type: object | |
10087 | rotational: | |
10088 | description: '' | |
10089 | properties: | |
10090 | '1': | |
10091 | description: '' | |
10092 | type: integer | |
10093 | required: | |
10094 | - '1' | |
10095 | type: object | |
10096 | required: | |
10097 | - osd_objectstore | |
10098 | - rotational | |
10099 | - arch | |
10100 | - ceph_version | |
10101 | - os | |
10102 | - cpu | |
10103 | - kernel_description | |
10104 | - kernel_version | |
10105 | - distro_description | |
10106 | - distro | |
10107 | type: object | |
10108 | required: | |
10109 | - osd | |
10110 | - mon | |
10111 | type: object | |
10112 | mon: | |
10113 | description: '' | |
10114 | properties: | |
10115 | count: | |
10116 | description: '' | |
10117 | type: integer | |
10118 | features: | |
10119 | description: '' | |
10120 | properties: | |
10121 | optional: | |
10122 | description: '' | |
10123 | items: | |
10124 | type: integer | |
10125 | type: array | |
10126 | persistent: | |
10127 | description: '' | |
10128 | items: | |
10129 | type: string | |
10130 | type: array | |
10131 | required: | |
10132 | - persistent | |
10133 | - optional | |
10134 | type: object | |
10135 | ipv4_addr_mons: | |
10136 | description: '' | |
10137 | type: integer | |
10138 | ipv6_addr_mons: | |
10139 | description: '' | |
10140 | type: integer | |
10141 | min_mon_release: | |
10142 | description: '' | |
10143 | type: integer | |
10144 | v1_addr_mons: | |
10145 | description: '' | |
10146 | type: integer | |
10147 | v2_addr_mons: | |
10148 | description: '' | |
10149 | type: integer | |
10150 | required: | |
10151 | - count | |
10152 | - features | |
10153 | - min_mon_release | |
10154 | - v1_addr_mons | |
10155 | - v2_addr_mons | |
10156 | - ipv4_addr_mons | |
10157 | - ipv6_addr_mons | |
10158 | type: object | |
10159 | osd: | |
10160 | description: '' | |
10161 | properties: | |
10162 | cluster_network: | |
10163 | description: '' | |
10164 | type: boolean | |
10165 | count: | |
10166 | description: '' | |
10167 | type: integer | |
10168 | require_min_compat_client: | |
10169 | description: '' | |
10170 | type: string | |
10171 | require_osd_release: | |
10172 | description: '' | |
10173 | type: string | |
10174 | required: | |
10175 | - count | |
10176 | - require_osd_release | |
10177 | - require_min_compat_client | |
10178 | - cluster_network | |
10179 | type: object | |
10180 | pools: | |
10181 | description: '' | |
10182 | items: | |
10183 | properties: | |
10184 | cache_mode: | |
10185 | description: '' | |
10186 | type: string | |
10187 | erasure_code_profile: | |
10188 | description: '' | |
10189 | type: string | |
10190 | min_size: | |
10191 | description: '' | |
10192 | type: integer | |
10193 | pg_autoscale_mode: | |
10194 | description: '' | |
10195 | type: string | |
10196 | pg_num: | |
10197 | description: '' | |
10198 | type: integer | |
10199 | pgp_num: | |
10200 | description: '' | |
10201 | type: integer | |
10202 | pool: | |
10203 | description: '' | |
10204 | type: integer | |
10205 | size: | |
10206 | description: '' | |
10207 | type: integer | |
10208 | target_max_bytes: | |
10209 | description: '' | |
10210 | type: integer | |
10211 | target_max_objects: | |
10212 | description: '' | |
10213 | type: integer | |
10214 | type: | |
10215 | description: '' | |
10216 | type: string | |
10217 | required: | |
10218 | - pool | |
10219 | - type | |
10220 | - pg_num | |
10221 | - pgp_num | |
10222 | - size | |
10223 | - min_size | |
10224 | - pg_autoscale_mode | |
10225 | - target_max_bytes | |
10226 | - target_max_objects | |
10227 | - erasure_code_profile | |
10228 | - cache_mode | |
10229 | type: object | |
10230 | type: array | |
10231 | rbd: | |
10232 | description: '' | |
10233 | properties: | |
10234 | mirroring_by_pool: | |
10235 | description: '' | |
10236 | items: | |
10237 | type: boolean | |
10238 | type: array | |
10239 | num_images_by_pool: | |
10240 | description: '' | |
10241 | items: | |
10242 | type: integer | |
10243 | type: array | |
10244 | num_pools: | |
10245 | description: '' | |
10246 | type: integer | |
10247 | required: | |
10248 | - num_pools | |
10249 | - num_images_by_pool | |
10250 | - mirroring_by_pool | |
10251 | type: object | |
10252 | report_id: | |
10253 | description: '' | |
10254 | type: string | |
10255 | report_timestamp: | |
10256 | description: '' | |
10257 | type: string | |
10258 | report_version: | |
10259 | description: '' | |
10260 | type: integer | |
10261 | rgw: | |
10262 | description: '' | |
10263 | properties: | |
10264 | count: | |
10265 | description: '' | |
10266 | type: integer | |
10267 | frontends: | |
10268 | description: '' | |
10269 | items: | |
10270 | type: string | |
10271 | type: array | |
10272 | zonegroups: | |
10273 | description: '' | |
10274 | type: integer | |
10275 | zones: | |
10276 | description: '' | |
10277 | type: integer | |
10278 | required: | |
10279 | - count | |
10280 | - zones | |
10281 | - zonegroups | |
10282 | - frontends | |
10283 | type: object | |
10284 | services: | |
10285 | description: '' | |
10286 | properties: | |
10287 | rgw: | |
10288 | description: '' | |
10289 | type: integer | |
10290 | required: | |
10291 | - rgw | |
10292 | type: object | |
10293 | usage: | |
10294 | description: '' | |
10295 | properties: | |
10296 | pg_num: | |
10297 | description: '' | |
10298 | type: integer | |
10299 | pools: | |
10300 | description: '' | |
10301 | type: integer | |
10302 | total_avail_bytes: | |
10303 | description: '' | |
10304 | type: integer | |
10305 | total_bytes: | |
10306 | description: '' | |
10307 | type: integer | |
10308 | total_used_bytes: | |
10309 | description: '' | |
10310 | type: integer | |
10311 | required: | |
10312 | - pools | |
10313 | - pg_num | |
10314 | - total_used_bytes | |
10315 | - total_bytes | |
10316 | - total_avail_bytes | |
10317 | type: object | |
10318 | required: | |
10319 | - leaderboard | |
10320 | - report_version | |
10321 | - report_timestamp | |
10322 | - report_id | |
10323 | - channels | |
10324 | - channels_available | |
10325 | - license | |
10326 | - created | |
10327 | - mon | |
10328 | - config | |
10329 | - rbd | |
10330 | - pools | |
10331 | - osd | |
10332 | - crush | |
10333 | - fs | |
10334 | - metadata | |
10335 | - hosts | |
10336 | - usage | |
10337 | - services | |
10338 | - rgw | |
10339 | - balancer | |
10340 | - crashes | |
10341 | type: object | |
10342 | required: | |
10343 | - report | |
10344 | - device_report | |
10345 | type: object | |
10346 | description: OK | |
10347 | '400': | |
10348 | description: Operation exception. Please check the response body for details. | |
10349 | '401': | |
10350 | description: Unauthenticated access. Please login first. | |
10351 | '403': | |
10352 | description: Unauthorized access. Please check your permissions. | |
10353 | '500': | |
10354 | description: Unexpected error. Please check the response body for the stack | |
10355 | trace. | |
10356 | security: | |
10357 | - jwt: [] | |
10358 | summary: Get Detailed Telemetry report | |
10359 | tags: | |
10360 | - Telemetry | |
10361 | /api/user: | |
10362 | get: | |
10363 | parameters: [] | |
10364 | responses: | |
10365 | '200': | |
10366 | content: | |
10367 | application/vnd.ceph.api.v1.0+json: | |
10368 | schema: | |
10369 | properties: | |
10370 | email: | |
10371 | description: User email address | |
10372 | type: string | |
10373 | enabled: | |
10374 | description: Is the user enabled? | |
10375 | type: boolean | |
10376 | lastUpdate: | |
10377 | description: Details last updated | |
10378 | type: integer | |
10379 | name: | |
10380 | description: User Name | |
10381 | type: string | |
10382 | pwdExpirationDate: | |
10383 | description: Password Expiration date | |
10384 | type: string | |
10385 | pwdUpdateRequired: | |
10386 | description: Is Password Update Required? | |
10387 | type: boolean | |
10388 | roles: | |
10389 | description: User Roles | |
10390 | items: | |
10391 | type: string | |
10392 | type: array | |
10393 | username: | |
10394 | description: Username of the user | |
10395 | type: string | |
10396 | required: | |
10397 | - username | |
10398 | - roles | |
10399 | - name | |
10400 | ||
10401 | - lastUpdate | |
10402 | - enabled | |
10403 | - pwdExpirationDate | |
10404 | - pwdUpdateRequired | |
10405 | type: object | |
10406 | description: OK | |
10407 | '400': | |
10408 | description: Operation exception. Please check the response body for details. | |
10409 | '401': | |
10410 | description: Unauthenticated access. Please login first. | |
10411 | '403': | |
10412 | description: Unauthorized access. Please check your permissions. | |
10413 | '500': | |
10414 | description: Unexpected error. Please check the response body for the stack | |
10415 | trace. | |
10416 | security: | |
10417 | - jwt: [] | |
10418 | summary: Get List Of Users | |
10419 | tags: | |
10420 | - User | |
10421 | post: | |
10422 | parameters: [] | |
10423 | requestBody: | |
10424 | content: | |
10425 | application/json: | |
10426 | schema: | |
10427 | properties: | |
10428 | email: | |
10429 | type: string | |
10430 | enabled: | |
10431 | default: true | |
10432 | type: boolean | |
10433 | name: | |
10434 | type: string | |
10435 | password: | |
10436 | type: string | |
10437 | pwdExpirationDate: | |
10438 | type: string | |
10439 | pwdUpdateRequired: | |
10440 | default: true | |
10441 | type: boolean | |
10442 | roles: | |
10443 | type: string | |
10444 | username: | |
10445 | type: string | |
10446 | type: object | |
10447 | responses: | |
10448 | '201': | |
10449 | content: | |
10450 | application/vnd.ceph.api.v1.0+json: | |
10451 | type: object | |
10452 | description: Resource created. | |
10453 | '202': | |
10454 | content: | |
10455 | application/vnd.ceph.api.v1.0+json: | |
10456 | type: object | |
10457 | description: Operation is still executing. Please check the task queue. | |
10458 | '400': | |
10459 | description: Operation exception. Please check the response body for details. | |
10460 | '401': | |
10461 | description: Unauthenticated access. Please login first. | |
10462 | '403': | |
10463 | description: Unauthorized access. Please check your permissions. | |
10464 | '500': | |
10465 | description: Unexpected error. Please check the response body for the stack | |
10466 | trace. | |
10467 | security: | |
10468 | - jwt: [] | |
10469 | tags: | |
10470 | - User | |
10471 | /api/user/validate_password: | |
10472 | post: | |
10473 | description: "\n Check if the password meets the password policy.\n \ | |
10474 | \ :param password: The password to validate.\n :param username:\ | |
10475 | \ The name of the user (optional).\n :param old_password: The old password\ | |
10476 | \ (optional).\n :return: An object with properties valid, credits and\ | |
10477 | \ valuation.\n 'credits' contains the password complexity credits and\n\ | |
10478 | \ 'valuation' the textual summary of the validation.\n " | |
10479 | parameters: [] | |
10480 | requestBody: | |
10481 | content: | |
10482 | application/json: | |
10483 | schema: | |
10484 | properties: | |
10485 | old_password: | |
10486 | type: string | |
10487 | password: | |
10488 | type: string | |
10489 | username: | |
10490 | type: string | |
10491 | required: | |
10492 | - password | |
10493 | type: object | |
10494 | responses: | |
10495 | '201': | |
10496 | content: | |
10497 | application/vnd.ceph.api.v1.0+json: | |
10498 | type: object | |
10499 | description: Resource created. | |
10500 | '202': | |
10501 | content: | |
10502 | application/vnd.ceph.api.v1.0+json: | |
10503 | type: object | |
10504 | description: Operation is still executing. Please check the task queue. | |
10505 | '400': | |
10506 | description: Operation exception. Please check the response body for details. | |
10507 | '401': | |
10508 | description: Unauthenticated access. Please login first. | |
10509 | '403': | |
10510 | description: Unauthorized access. Please check your permissions. | |
10511 | '500': | |
10512 | description: Unexpected error. Please check the response body for the stack | |
10513 | trace. | |
10514 | security: | |
10515 | - jwt: [] | |
10516 | tags: | |
10517 | - UserPasswordPolicy | |
10518 | /api/user/{username}: | |
10519 | delete: | |
10520 | parameters: | |
10521 | - in: path | |
10522 | name: username | |
10523 | required: true | |
10524 | schema: | |
10525 | type: string | |
10526 | responses: | |
10527 | '202': | |
10528 | content: | |
10529 | application/vnd.ceph.api.v1.0+json: | |
10530 | type: object | |
10531 | description: Operation is still executing. Please check the task queue. | |
10532 | '204': | |
10533 | content: | |
10534 | application/vnd.ceph.api.v1.0+json: | |
10535 | type: object | |
10536 | description: Resource deleted. | |
10537 | '400': | |
10538 | description: Operation exception. Please check the response body for details. | |
10539 | '401': | |
10540 | description: Unauthenticated access. Please login first. | |
10541 | '403': | |
10542 | description: Unauthorized access. Please check your permissions. | |
10543 | '500': | |
10544 | description: Unexpected error. Please check the response body for the stack | |
10545 | trace. | |
10546 | security: | |
10547 | - jwt: [] | |
10548 | tags: | |
10549 | - User | |
10550 | get: | |
10551 | parameters: | |
10552 | - in: path | |
10553 | name: username | |
10554 | required: true | |
10555 | schema: | |
10556 | type: string | |
10557 | responses: | |
10558 | '200': | |
10559 | content: | |
10560 | application/vnd.ceph.api.v1.0+json: | |
10561 | type: object | |
10562 | description: OK | |
10563 | '400': | |
10564 | description: Operation exception. Please check the response body for details. | |
10565 | '401': | |
10566 | description: Unauthenticated access. Please login first. | |
10567 | '403': | |
10568 | description: Unauthorized access. Please check your permissions. | |
10569 | '500': | |
10570 | description: Unexpected error. Please check the response body for the stack | |
10571 | trace. | |
10572 | security: | |
10573 | - jwt: [] | |
10574 | tags: | |
10575 | - User | |
10576 | put: | |
10577 | parameters: | |
10578 | - in: path | |
10579 | name: username | |
10580 | required: true | |
10581 | schema: | |
10582 | type: string | |
10583 | requestBody: | |
10584 | content: | |
10585 | application/json: | |
10586 | schema: | |
10587 | properties: | |
10588 | email: | |
10589 | type: string | |
10590 | enabled: | |
10591 | type: string | |
10592 | name: | |
10593 | type: string | |
10594 | password: | |
10595 | type: string | |
10596 | pwdExpirationDate: | |
10597 | type: string | |
10598 | pwdUpdateRequired: | |
10599 | default: false | |
10600 | type: boolean | |
10601 | roles: | |
10602 | type: string | |
10603 | type: object | |
10604 | responses: | |
10605 | '200': | |
10606 | content: | |
10607 | application/vnd.ceph.api.v1.0+json: | |
10608 | type: object | |
10609 | description: Resource updated. | |
10610 | '202': | |
10611 | content: | |
10612 | application/vnd.ceph.api.v1.0+json: | |
10613 | type: object | |
10614 | description: Operation is still executing. Please check the task queue. | |
10615 | '400': | |
10616 | description: Operation exception. Please check the response body for details. | |
10617 | '401': | |
10618 | description: Unauthenticated access. Please login first. | |
10619 | '403': | |
10620 | description: Unauthorized access. Please check your permissions. | |
10621 | '500': | |
10622 | description: Unexpected error. Please check the response body for the stack | |
10623 | trace. | |
10624 | security: | |
10625 | - jwt: [] | |
10626 | tags: | |
10627 | - User | |
10628 | /api/user/{username}/change_password: | |
10629 | post: | |
10630 | parameters: | |
10631 | - in: path | |
10632 | name: username | |
10633 | required: true | |
10634 | schema: | |
10635 | type: string | |
10636 | requestBody: | |
10637 | content: | |
10638 | application/json: | |
10639 | schema: | |
10640 | properties: | |
10641 | new_password: | |
10642 | type: string | |
10643 | old_password: | |
10644 | type: string | |
10645 | required: | |
10646 | - old_password | |
10647 | - new_password | |
10648 | type: object | |
10649 | responses: | |
10650 | '201': | |
10651 | content: | |
10652 | application/vnd.ceph.api.v1.0+json: | |
10653 | type: object | |
10654 | description: Resource created. | |
10655 | '202': | |
10656 | content: | |
10657 | application/vnd.ceph.api.v1.0+json: | |
10658 | type: object | |
10659 | description: Operation is still executing. Please check the task queue. | |
10660 | '400': | |
10661 | description: Operation exception. Please check the response body for details. | |
10662 | '401': | |
10663 | description: Unauthenticated access. Please login first. | |
10664 | '403': | |
10665 | description: Unauthorized access. Please check your permissions. | |
10666 | '500': | |
10667 | description: Unexpected error. Please check the response body for the stack | |
10668 | trace. | |
10669 | security: | |
10670 | - jwt: [] | |
10671 | tags: | |
10672 | - UserChangePassword | |
10673 | schemes: | |
10674 | - https | |
10675 | servers: | |
10676 | - url: / | |
10677 | tags: | |
10678 | - description: Initiate a session with Ceph | |
10679 | name: Auth | |
10680 | - description: Cephfs Management API | |
10681 | name: Cephfs | |
a4b75251 TL |
10682 | - description: Get Cluster Details |
10683 | name: Cluster | |
f67539c2 TL |
10684 | - description: Manage Cluster Configurations |
10685 | name: ClusterConfiguration | |
10686 | - description: Crush Rule Management API | |
10687 | name: CrushRule | |
20effc67 TL |
10688 | - description: Perform actions on daemons |
10689 | name: Daemon | |
f67539c2 TL |
10690 | - description: Erasure Code Profile Management API |
10691 | name: ErasureCodeProfile | |
10692 | - description: Manage Features API | |
10693 | name: FeatureTogglesEndpoint | |
10694 | - description: Grafana Management API | |
10695 | name: Grafana | |
10696 | - description: Display Detailed Cluster health Status | |
10697 | name: Health | |
10698 | - description: Get Host Details | |
10699 | name: Host | |
10700 | - description: Iscsi Management API | |
10701 | name: Iscsi | |
10702 | - description: Get Iscsi Target Details | |
10703 | name: IscsiTarget | |
10704 | - description: Logs Management API | |
10705 | name: Logs | |
10706 | - description: Mds Perf Counters Management API | |
10707 | name: MdsPerfCounter | |
10708 | - description: Get details of MGR Module | |
10709 | name: MgrModule | |
10710 | - description: Mgr Perf Counters Management API | |
10711 | name: MgrPerfCounter | |
10712 | - description: Mon Perf Counters Management API | |
10713 | name: MonPerfCounter | |
10714 | - description: Get Monitor Details | |
10715 | name: Monitor | |
a4b75251 | 10716 | - description: NFS-Ganesha Cluster Management API |
f67539c2 TL |
10717 | name: NFS-Ganesha |
10718 | - description: OSD management API | |
10719 | name: OSD | |
f67539c2 TL |
10720 | - description: OSD Perf Counters Management API |
10721 | name: OsdPerfCounter | |
10722 | - description: Perf Counters Management API | |
10723 | name: PerfCounters | |
10724 | - description: Get pool details by pool name | |
10725 | name: Pool | |
10726 | - description: Prometheus Management API | |
10727 | name: Prometheus | |
10728 | - description: Prometheus Notifications Management API | |
10729 | name: PrometheusNotifications | |
10730 | - description: RBD Management API | |
10731 | name: Rbd | |
10732 | - description: RBD Mirroring Management API | |
10733 | name: RbdMirroring | |
10734 | - description: RBD Mirroring Pool Bootstrap Management API | |
10735 | name: RbdMirroringPoolBootstrap | |
10736 | - description: RBD Mirroring Pool Mode Management API | |
10737 | name: RbdMirroringPoolMode | |
10738 | - description: RBD Mirroring Pool Peer Management API | |
10739 | name: RbdMirroringPoolPeer | |
10740 | - description: RBD Mirroring Summary Management API | |
10741 | name: RbdMirroringSummary | |
10742 | - description: RBD Namespace Management API | |
10743 | name: RbdNamespace | |
10744 | - description: RBD Snapshot Management API | |
10745 | name: RbdSnapshot | |
10746 | - description: RBD Trash Management API | |
10747 | name: RbdTrash | |
20effc67 TL |
10748 | - description: Feedback API |
10749 | name: Report | |
f67539c2 TL |
10750 | - description: RGW Bucket Management API |
10751 | name: RgwBucket | |
10752 | - description: RGW Daemon Management API | |
10753 | name: RgwDaemon | |
10754 | - description: Rgw Mirroring Perf Counters Management API | |
10755 | name: RgwMirrorPerfCounter | |
10756 | - description: Rgw Perf Counters Management API | |
10757 | name: RgwPerfCounter | |
10758 | - description: RGW Site Management API | |
10759 | name: RgwSite | |
10760 | - description: RGW User Management API | |
10761 | name: RgwUser | |
10762 | - description: Role Management API | |
10763 | name: Role | |
10764 | - description: Service Management API | |
10765 | name: Service | |
10766 | - description: Settings Management API | |
10767 | name: Settings | |
10768 | - description: Get Ceph Summary Details | |
10769 | name: Summary | |
10770 | - description: Task Management API | |
10771 | name: Task | |
10772 | - description: Tcmu Runner Perf Counters Management API | |
10773 | name: TcmuRunnerPerfCounter | |
10774 | - description: Display Telemetry Report | |
10775 | name: Telemetry | |
10776 | - description: Display User Details | |
10777 | name: User | |
10778 | - description: Change User Password | |
10779 | name: UserChangePassword | |
10780 | - description: Get User Password Policy Details | |
10781 | name: UserPasswordPolicy |