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