forked from libopenstorage/openstorage-sdk-clients
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.swagger.json
8497 lines (8497 loc) · 274 KB
/
api.swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"components": {
"schemas": {
"CloudMigrateStage": {
"default": "InvalidStage",
"enum": [
"InvalidStage",
"Backup",
"Restore",
"VolumeUpdate",
"Done"
],
"type": "string"
},
"ClusterPairModeMode": {
"default": "Default",
"enum": [
"Default",
"DisasterRecovery"
],
"title": "- Default: Default pairing mode\n - DisasterRecovery: Paired for DisasterRecovery",
"type": "string"
},
"FilesystemCheckFilesystemCheckStatus": {
"default": "FS_CHECK_UNKNOWN",
"description": "- FS_CHECK_UNKNOWN: Filesystem Check operation is an unknown state\n - FS_CHECK_NOT_RUNNING: FilesystemCheck operation not running for the specified volume\n - FS_CHECK_STARTED: FilesystemCheck operation started for the specified volume\n - FS_CHECK_INPROGRESS: FilesystemCheck operation is in progress\n - FS_CHECK_STOPPED: FilesystemCheck operation was stopped by the user\n - FS_CHECK_COMPLETED: FilesystemCheck operation completed successfully\n - FS_CHECK_FAILED: FilesystemCheck operation failed due to internal error",
"enum": [
"FS_CHECK_UNKNOWN",
"FS_CHECK_NOT_RUNNING",
"FS_CHECK_STARTED",
"FS_CHECK_INPROGRESS",
"FS_CHECK_STOPPED",
"FS_CHECK_COMPLETED",
"FS_CHECK_FAILED"
],
"title": "FilesystemChecktatus represents the status codes returned from\nOpenStorageFilesystemCheck service APIs()",
"type": "string"
},
"FilesystemTrimFilesystemTrimStatus": {
"default": "FS_TRIM_UNKNOWN",
"description": "- FS_TRIM_UNKNOWN: Filesystem Trim operation is an unknown state\n - FS_TRIM_NOT_RUNNING: Filesystem Trim operation is not running for the specified volume\n - FS_TRIM_STARTED: Filesystem Trim operation started for the specified volume\n - FS_TRIM_INPROGRESS: Filesystem Trim operation is in progress for the specified volume\n - FS_TRIM_STOPPED: Filesystem Trim operation was stopped by the user for the specified volume\n - FS_TRIM_COMPLETED: Filesystem Trim operation completed successfully for the specified volume\n - FS_TRIM_FAILED: Filesystem Trim operation failed due to internal error for the specified\nvolume",
"enum": [
"FS_TRIM_UNKNOWN",
"FS_TRIM_NOT_RUNNING",
"FS_TRIM_STARTED",
"FS_TRIM_INPROGRESS",
"FS_TRIM_STOPPED",
"FS_TRIM_COMPLETED",
"FS_TRIM_FAILED"
],
"title": "FilesystemTrimStatus represents the status codes returned from\nOpenStorageFilesystemTrim service APIs()",
"type": "string"
},
"JobState": {
"default": "UNSPECIFIED_STATE",
"description": "- UNSPECIFIED_STATE: Unspecified\n - PENDING: Pending indicates job is still pending and has not started work\n - RUNNING: Running indicates job is actively running\n - DONE: Done indicates job has finished processing\n - PAUSED: Paused indicates job is paused\n - CANCELLED: Cancelled indicates job is cancelled\n - FAILED: Failed indicates job has failed",
"enum": [
"UNSPECIFIED_STATE",
"PENDING",
"RUNNING",
"DONE",
"PAUSED",
"CANCELLED",
"FAILED"
],
"title": "State is an enum for state of a node drain operation",
"type": "string"
},
"LabelSelectorRequirementOperator": {
"default": "In",
"description": "- In: In means the value for 'key' should be in one of the given value(s)\n - NotIn: NotIn means the value for 'key' should NOT be in one of the given value(s)\n - Exists: Exists means the 'key' should just exist regardless of the value\n - DoesNotExist: DoesNotExist means the 'key' should NOT exist\n - Gt: Gt means the 'key' should be greater than the value(s)\n - Lt: Lt means the 'key' should be less than the value(s)",
"enum": [
"In",
"NotIn",
"Exists",
"DoesNotExist",
"Gt",
"Lt"
],
"title": "This defines operator types used in a label matching rule",
"type": "string"
},
"OwnershipAccessControl": {
"properties": {
"collaborators": {
"additionalProperties": {
"$ref": "#/components/schemas/OwnershipAccessType"
},
"description": "Collaborator access to resource gives access to other user.\nMust be the username (unique id) set in the authorization token.\nThe owner or the administrator can set this value. Possible values are:\n1. no collaborators: Means no users are given access.\n2. `[\"*\"]`: All users are allowed.\n3. `[\"username1\", \"username2\"]`: Only certain usernames are allowed. In this example only\n_username1_ and _username2_ are allowed.",
"type": "object"
},
"groups": {
"additionalProperties": {
"$ref": "#/components/schemas/OwnershipAccessType"
},
"description": "Group access to resource which must match the group set in the\nauthorization token.\nCan be set by the owner or the system administrator only.\nPossible values are:\n1. no groups: Means no groups are given access.\n2. `[\"*\"]`: All groups are allowed.\n3. `[\"group1\", \"group2\"]`: Only certain groups are allowed. In this example only\n_group1_ and _group2_ are allowed.",
"type": "object"
},
"public": {
"$ref": "#/components/schemas/OwnershipPublicAccessControl"
}
},
"type": "object"
},
"OwnershipAccessType": {
"default": "Read",
"description": "Access types can be set by owner to have different levels of access to\na resource.\n\nIt is up to the resource to interpret what the types mean and are\nused for.\n\n - Read: Read access only and cannot affect the resource.\n - Write: Write access and can affect the resource.\nThis type automatically provides Read access also.\n - Admin: Administrator access.\nThis type automatically provides Read and Write access also.",
"enum": [
"Read",
"Write",
"Admin"
],
"type": "string"
},
"OwnershipPublicAccessControl": {
"properties": {
"type": {
"$ref": "#/components/schemas/OwnershipAccessType"
}
},
"title": "PublicAccessControl allows assigning public ownership",
"type": "object"
},
"ScanPolicyScanAction": {
"default": "SCAN_ACTION_NONE",
"enum": [
"SCAN_ACTION_NONE",
"SCAN_ACTION_SCAN_ONLY",
"SCAN_ACTION_SCAN_REPAIR"
],
"type": "string"
},
"ScanPolicyScanTrigger": {
"default": "SCAN_TRIGGER_NONE",
"enum": [
"SCAN_TRIGGER_NONE",
"SCAN_TRIGGER_ON_MOUNT",
"SCAN_TRIGGER_ON_NEXT_MOUNT"
],
"type": "string"
},
"SdkCloudMigrateStartRequestMigrateAllVolumes": {
"title": "Defines a migration request for all volumes in a cluster",
"type": "object"
},
"SdkCloudMigrateStartRequestMigrateVolume": {
"properties": {
"volume_id": {
"type": "string"
}
},
"title": "Defines a migration request for a volume",
"type": "object"
},
"SdkCloudMigrateStartRequestMigrateVolumeGroup": {
"properties": {
"group_id": {
"type": "string"
}
},
"title": "Defines a migration request for a volume group",
"type": "object"
},
"SdkServiceCapabilityOpenStorageService": {
"properties": {
"type": {
"$ref": "#/components/schemas/SdkServiceCapabilityOpenStorageServiceType"
}
},
"type": "object"
},
"SdkServiceCapabilityOpenStorageServiceType": {
"default": "UNKNOWN",
"enum": [
"UNKNOWN",
"CLUSTER",
"CLOUD_BACKUP",
"CREDENTIALS",
"NODE",
"OBJECT_STORAGE",
"SCHEDULE_POLICY",
"VOLUME",
"ALERTS",
"MOUNT_ATTACH",
"ROLE",
"CLUSTER_PAIR",
"MIGRATE",
"STORAGE_POLICY"
],
"title": "- UNKNOWN: Unknown service\n - CLUSTER: Cluster management\n - CLOUD_BACKUP: Cloud backup of volumes management\n - CREDENTIALS: Credentials management\n - NODE: Node management\n - OBJECT_STORAGE: Object Storage management\n - SCHEDULE_POLICY: Schedule policy management\n - VOLUME: Volume management\n - ALERTS: Alert enumeration\n - MOUNT_ATTACH: Mount/Attach Support\n - ROLE: Role service\n - CLUSTER_PAIR: Cluster Pair service\n - MIGRATE: Migrate service\n - STORAGE_POLICY: StoragePolicy Service",
"type": "string"
},
"SdkStoragePoolOperationStatus": {
"default": "OPERATION_PENDING",
"description": "- OPERATION_PENDING: Operation pending\n - OPERATION_IN_PROGRESS: Operation is in progress\n - OPERATION_SUCCESSFUL: Operation is successful\n - OPERATION_FAILED: Operation failed",
"enum": [
"OPERATION_PENDING",
"OPERATION_IN_PROGRESS",
"OPERATION_SUCCESSFUL",
"OPERATION_FAILED"
],
"title": "OperationStatus captures the various statuses of a storage pool operation",
"type": "string"
},
"SdkStoragePoolResizeOperationType": {
"default": "RESIZE_TYPE_AUTO",
"description": "- RESIZE_TYPE_AUTO: Automatically pick the optimum resize operation type\n - RESIZE_TYPE_ADD_DISK: Add a new drive to resize the pool\n - RESIZE_TYPE_RESIZE_DISK: Resize existing drives to resize the pool",
"enum": [
"RESIZE_TYPE_AUTO",
"RESIZE_TYPE_ADD_DISK",
"RESIZE_TYPE_RESIZE_DISK"
],
"title": "Defines the operation types available to resize a storage pool",
"type": "string"
},
"StorageRebalanceAuditStorageRebalanceAction": {
"default": "ADD_REPLICA",
"description": "- ADD_REPLICA: Indicates new replica was added\n - REMOVE_REPLICA: Indicates existing replica was removed",
"enum": [
"ADD_REPLICA",
"REMOVE_REPLICA"
],
"title": "StorageRebalanceAction describes type of rebalance action",
"type": "string"
},
"StorageRebalanceTriggerThresholdMetric": {
"default": "PROVISION_SPACE",
"description": "- PROVISION_SPACE: ProvisionSpace indicates rebalance for provisioned space\n - USED_SPACE: UsedSpace indicates rebalance for used space",
"enum": [
"PROVISION_SPACE",
"USED_SPACE"
],
"title": "Metric is an enum that defines the metric to use for rebalance",
"type": "string"
},
"VolumeSpecPolicyPolicyOp": {
"default": "Equal",
"description": "- Equal: Policy will make sure the value must be equal\n - Minimum: Policy will make sure the requested value must be greater than or equal\n - Maximum: Policy will make sure the requested value must be less than or equal",
"enum": [
"Equal",
"Minimum",
"Maximum"
],
"title": "This defines an operator for the policy comparisons",
"type": "string"
},
"XattrValue": {
"default": "UNSPECIFIED",
"enum": [
"UNSPECIFIED",
"COW_ON_DEMAND"
],
"title": "- UNSPECIFIED: Value is uninitialized or unknown\n - COW_ON_DEMAND: Enable on-demand copy-on-write on the volume",
"type": "string"
},
"apiAlert": {
"properties": {
"alert_type": {
"format": "int64",
"title": "AlertType user defined alert type",
"type": "string"
},
"cleared": {
"format": "boolean",
"title": "Cleared Flag",
"type": "boolean"
},
"count": {
"description": "Count of such alerts raised so far.",
"format": "int64",
"type": "string"
},
"first_seen": {
"description": "Timestamp when such alert was raised the very first time.",
"format": "date-time",
"type": "string"
},
"id": {
"format": "int64",
"title": "Id for Alert",
"type": "string"
},
"message": {
"title": "Message describing the Alert",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/apiResourceType"
},
"resource_id": {
"title": "ResourceId where Alert occured",
"type": "string"
},
"severity": {
"$ref": "#/components/schemas/apiSeverityType"
},
"timestamp": {
"format": "date-time",
"title": "Timestamp when Alert occured",
"type": "string"
},
"ttl": {
"format": "uint64",
"title": "Time-to-live in seconds for this Alert",
"type": "string"
},
"unique_tag": {
"title": "UniqueTag helps identify a unique alert for a given resouce",
"type": "string"
}
},
"title": "Alert is a structure that represents an alert object",
"type": "object"
},
"apiAttachState": {
"default": "ATTACH_STATE_EXTERNAL",
"enum": [
"ATTACH_STATE_EXTERNAL",
"ATTACH_STATE_INTERNAL",
"ATTACH_STATE_INTERNAL_SWITCH"
],
"title": "- ATTACH_STATE_EXTERNAL: Attached and available externally\n - ATTACH_STATE_INTERNAL: Attached but only available internally\n - ATTACH_STATE_INTERNAL_SWITCH: Switching from External to Internal",
"type": "string"
},
"apiCapacityUsageInfo": {
"description": "Provides details on exclusive and shared storage used by\nsnapshot/volume specifically for copy-on-write(COW) snapshots. Deletion\nof snapshots and overwirte of volume will affect the exclusive storage\nused by the other dependent snaps and parent volume.",
"properties": {
"exclusive_bytes": {
"description": "Storage consumed exclusively by this single snapshot. Deletion of this\nsnapshot may increase the free storage available by this amount.",
"format": "int64",
"type": "string"
},
"shared_bytes": {
"format": "int64",
"title": "Storage consumed by this snapshot that is shared with parent and children",
"type": "string"
},
"total_bytes": {
"format": "int64",
"title": "TotalBytes used by this volume",
"type": "string"
}
},
"type": "object"
},
"apiCatalog": {
"properties": {
"LastModified": {
"format": "date-time",
"title": "Last Modified",
"type": "string"
},
"children": {
"items": {
"$ref": "#/components/schemas/apiCatalog"
},
"title": "Children",
"type": "array"
},
"name": {
"title": "Name of the Directory/File",
"type": "string"
},
"path": {
"title": "Full Path of the Directory/File",
"type": "string"
},
"size": {
"format": "uint64",
"title": "File or Directory Size",
"type": "string"
},
"type": {
"title": "Type Directory or File",
"type": "string"
}
},
"type": "object"
},
"apiCatalogResponse": {
"properties": {
"report": {
"$ref": "#/components/schemas/apiReport"
},
"root": {
"$ref": "#/components/schemas/apiCatalog"
}
},
"type": "object"
},
"apiCloudDriveTransferJob": {
"properties": {
"destination_instance_id": {
"title": "DestinationInstanceID is the ID of the storageless instance that needs to take over the SourceDriveSetID",
"type": "string"
},
"source_driveset_id": {
"title": "SourceDrivesetID is the ID of the current driveset that needs to be transferred",
"type": "string"
},
"status": {
"title": "Status describes a helpful status of this operation",
"type": "string"
}
},
"type": "object"
},
"apiCloudMigrateCancelRequest": {
"properties": {
"task_id": {
"title": "The id of the task to cancel",
"type": "string"
}
},
"title": "Request to stop a cloud migration",
"type": "object"
},
"apiCloudMigrateInfo": {
"properties": {
"bytes_done": {
"format": "uint64",
"title": "BytesDone is the number of bytes already transferred",
"type": "string"
},
"bytes_total": {
"format": "uint64",
"title": "BytesTotal is the number of bytes being transferred",
"type": "string"
},
"cloudbackup_id": {
"title": "ID of the cloudbackup used for the migration",
"type": "string"
},
"cluster_id": {
"title": "ID of the cluster where the volume is being migrated",
"type": "string"
},
"completed_time": {
"format": "date-time",
"title": "CompletedTime indicates Op's completed time",
"type": "string"
},
"current_stage": {
"$ref": "#/components/schemas/CloudMigrateStage"
},
"error_reason": {
"title": "Contains the reason for the migration error",
"type": "string"
},
"eta_seconds": {
"format": "int64",
"title": "ETASeconds the time duration in seconds for cloud migration completion",
"type": "string"
},
"last_update": {
"format": "date-time",
"title": "Last time the status was updated",
"type": "string"
},
"local_volume_id": {
"title": "ID of the volume on the local cluster",
"type": "string"
},
"local_volume_name": {
"title": "Name of the volume on the local cluster",
"type": "string"
},
"remote_volume_id": {
"title": "ID of the volume on the remote cluster",
"type": "string"
},
"start_time": {
"format": "date-time",
"title": "StartTime indicates Op's start time",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/apiCloudMigrateStatus"
},
"task_id": {
"title": "Task id associated with this migration",
"type": "string"
}
},
"type": "object"
},
"apiCloudMigrateInfoList": {
"properties": {
"list": {
"items": {
"$ref": "#/components/schemas/apiCloudMigrateInfo"
},
"type": "array"
}
},
"type": "object"
},
"apiCloudMigrateStartResponse": {
"properties": {
"task_id": {
"title": "TaskId assocaiated with the migration that was started",
"type": "string"
}
},
"title": "Response to start a cloud migration",
"type": "object"
},
"apiCloudMigrateStatus": {
"default": "InvalidStatus",
"enum": [
"InvalidStatus",
"Queued",
"Initialized",
"InProgress",
"Failed",
"Complete",
"Canceled"
],
"type": "string"
},
"apiCloudMigrateStatusRequest": {
"properties": {
"cluster_id": {
"title": "ID of the cluster for which to return migration statuses",
"type": "string"
},
"task_id": {
"title": "Task id for which to return status",
"type": "string"
}
},
"title": "Request for cloud migration operation status",
"type": "object"
},
"apiCloudMigrateStatusResponse": {
"properties": {
"info": {
"additionalProperties": {
"$ref": "#/components/schemas/apiCloudMigrateInfoList"
},
"title": "Map of cluster id to the status of volumes being migrated",
"type": "object"
}
},
"title": "Response with a status of the cloud migration operations",
"type": "object"
},
"apiClusterPairCreateRequest": {
"properties": {
"credential_id": {
"title": "Use for the cluster pairing, if given\ncredential id will be used in ClusterPairCreate service",
"type": "string"
},
"mode": {
"$ref": "#/components/schemas/ClusterPairModeMode"
},
"remote_cluster_ip": {
"title": "IP of the remote cluster",
"type": "string"
},
"remote_cluster_port": {
"format": "int64",
"title": "Port for the remote cluster",
"type": "integer"
},
"remote_cluster_token": {
"title": "Token used to authenticate with the remote cluster",
"type": "string"
},
"set_default": {
"format": "boolean",
"title": "Set the new pair as the default",
"type": "boolean"
}
},
"title": "Used to send a request to create a cluster pair",
"type": "object"
},
"apiClusterPairCreateResponse": {
"properties": {
"remote_cluster_id": {
"title": "ID of the remote cluster",
"type": "string"
},
"remote_cluster_name": {
"title": "Name of the remote cluster",
"type": "string"
}
},
"title": "Response for a pair request",
"type": "object"
},
"apiClusterPairGetResponse": {
"properties": {
"pair_info": {
"$ref": "#/components/schemas/apiClusterPairInfo"
}
},
"title": "Reponse to get a cluster pair",
"type": "object"
},
"apiClusterPairInfo": {
"properties": {
"current_endpoints": {
"items": {
"type": "string"
},
"title": "Current endpoints of the cluster",
"type": "array"
},
"endpoint": {
"title": "The endpoint used for creating the pair",
"type": "string"
},
"id": {
"title": "ID of the cluster",
"type": "string"
},
"mode": {
"$ref": "#/components/schemas/ClusterPairModeMode"
},
"name": {
"title": "Name of the cluster",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"title": "Key/value pair of options associated with the cluster\nOpaque to openstorage and interpreted by the drivers",
"type": "object"
},
"secure": {
"format": "boolean",
"title": "Flag used to determine if communication is over a secure channel",
"type": "boolean"
},
"token": {
"title": "Token associated with cluster",
"type": "string"
}
},
"title": "Information about a cluster pair",
"type": "object"
},
"apiClusterPairTokenGetResponse": {
"properties": {
"token": {
"title": "Token used to authenticate clusters",
"type": "string"
}
},
"title": "Response to get the cluster token",
"type": "object"
},
"apiClusterPairsEnumerateResponse": {
"properties": {
"default_id": {
"title": "ID of the default cluster pair",
"type": "string"
},
"pairs": {
"additionalProperties": {
"$ref": "#/components/schemas/apiClusterPairInfo"
},
"title": "Pairs Info about the cluster pairs",
"type": "object"
}
},
"title": "Response to enumerate all the cluster pairs",
"type": "object"
},
"apiCosType": {
"default": "NONE",
"enum": [
"NONE",
"LOW",
"MEDIUM",
"HIGH"
],
"type": "string"
},
"apiDrainAttachmentsSummary": {
"properties": {
"num_volumes_done": {
"format": "uint64",
"title": "Number of volumes which have been drained",
"type": "string"
},
"num_volumes_pending": {
"format": "uint64",
"title": "Number of volumes which have not been drained yet",
"type": "string"
},
"num_volumes_total": {
"format": "uint64",
"title": "Total number of volumes that need to be drained",
"type": "string"
}
},
"title": "DrainAttachments summary of the volumes whose attachments need to be drained\nfrom a node",
"type": "object"
},
"apiEnforcementType": {
"default": "required",
"description": "- required: This specifies that the rule is required and must be strictly enforced\n - preferred: This specifies that the rule is preferred and can be best effort",
"enum": [
"required",
"preferred"
],
"title": "Defines the types of enforcement on the given rules",
"type": "string"
},
"apiExportProtocol": {
"default": "INVALID",
"description": "ExportProtocol defines how the device is exported..\n\n - INVALID: Invalid uninitialized value\n - PXD: PXD the volume is exported over Portworx block interace.\n - ISCSI: ISCSI the volume is exported over ISCSI.\n - NFS: NFS the volume is exported over NFS.\n - CUSTOM: Custom the volume is exported over custom interace.",
"enum": [
"INVALID",
"PXD",
"ISCSI",
"NFS",
"CUSTOM"
],
"type": "string"
},
"apiExportSpec": {
"description": "ExportSpec defines how the volume is exported..",
"properties": {
"export_options": {
"description": "ExportOptions options exporting the volume.",
"type": "string"
},
"export_protocol": {
"$ref": "#/components/schemas/apiExportProtocol"
}
},
"type": "object"
},
"apiFSType": {
"default": "FS_TYPE_NONE",
"enum": [
"FS_TYPE_NONE",
"FS_TYPE_BTRFS",
"FS_TYPE_EXT4",
"FS_TYPE_FUSE",
"FS_TYPE_NFS",
"FS_TYPE_VFS",
"FS_TYPE_XFS",
"FS_TYPE_ZFS",
"FS_TYPE_XFSv2"
],
"type": "string"
},
"apiFastpathConfig": {
"properties": {
"coord_uuid": {
"title": "fastpath coordinator node uuid to enhance reporting",
"type": "string"
},
"dirty": {
"format": "boolean",
"title": "Dirty flag on volume - was attached in userspace",
"type": "boolean"
},
"promote": {
"format": "boolean",
"title": "Fastpath temporary promotion during attach",
"type": "boolean"
},
"replicas": {
"items": {
"$ref": "#/components/schemas/apiFastpathReplState"
},
"title": "Fastpath replica state for each replica in replica set",
"type": "array"
},
"setup_on": {
"format": "int32",
"title": "fastpath setup on this node",
"type": "integer"
},
"status": {
"$ref": "#/components/schemas/apiFastpathStatus"
}
},
"title": "FastpathConfig part of volume",
"type": "object"
},
"apiFastpathProtocol": {
"default": "FASTPATH_PROTO_UNKNOWN",
"enum": [
"FASTPATH_PROTO_UNKNOWN",
"FASTPATH_PROTO_NVMEOF_TCP",
"FASTPATH_PROTO_ISCSI",
"FASTPATH_PROTO_LOCAL"
],
"type": "string"
},
"apiFastpathReplState": {
"properties": {
"acl": {
"format": "boolean",
"type": "boolean"
},
"block": {
"format": "boolean",
"type": "boolean"
},
"dev_id": {
"format": "uint64",
"type": "string"
},
"devpath": {
"type": "string"
},
"exported": {
"format": "boolean",
"type": "boolean"
},
"exported_device": {
"title": "target info",
"type": "string"
},
"imported": {
"format": "boolean",
"title": "initiator info",
"type": "boolean"
},
"node_id": {
"format": "int64",
"type": "integer"
},
"node_uuid": {
"title": "node_uuid added to enhance UI reporting",
"type": "string"
},
"protocol": {
"$ref": "#/components/schemas/apiFastpathProtocol"
},
"target": {
"type": "string"
}
},
"type": "object"
},
"apiFastpathStatus": {
"default": "FASTPATH_UNKNOWN",
"description": "- FASTPATH_UNKNOWN: backward compatible state\n - FASTPATH_ACTIVE: fastpath activated and enabled\n - FASTPATH_INACTIVE: fastpath inactive\n - FASTPATH_UNSUPPORTED: fastpath unsupported, disabled\n - FASTPATH_PENDING: fastpath operation setup in progress\n - FASTPATH_ERRORED: fastpath error'd, possible stuck failure",
"enum": [
"FASTPATH_UNKNOWN",
"FASTPATH_ACTIVE",
"FASTPATH_INACTIVE",
"FASTPATH_UNSUPPORTED",
"FASTPATH_PENDING",
"FASTPATH_ERRORED"
],
"title": "fastpath extensions",
"type": "string"
},
"apiFilesystemHealthStatus": {
"default": "FS_HEALTH_STATUS_UNKNOWN",
"enum": [
"FS_HEALTH_STATUS_UNKNOWN",
"FS_HEALTH_STATUS_HEALTHY",
"FS_HEALTH_STATUS_SAFE_TO_FIX",
"FS_HEALTH_STATUS_NEEDS_INSPECTION"
],
"title": "- FS_HEALTH_STATUS_UNKNOWN: filesystem health status is unknown\n - FS_HEALTH_STATUS_HEALTHY: filesystem is a healthy\n - FS_HEALTH_STATUS_SAFE_TO_FIX: filesystem has errors, but can be fixed safely\n - FS_HEALTH_STATUS_NEEDS_INSPECTION: filesystem has errors, these cannot be fixed automatically,\nuser needs to review the reported errors and take appropriate action",
"type": "string"
},
"apiGroup": {
"description": "Group represents VolumeGroup / namespace\nAll volumes in the same group share this object.",
"properties": {
"id": {
"description": "Id common identifier across volumes that have the same group.",
"type": "string"
}
},
"type": "object"
},
"apiHardwareType": {
"default": "UnknownMachine",
"enum": [
"UnknownMachine",
"VirtualMachine",
"BareMetalMachine"
],
"title": "- UnknownMachine: When we do not know the machine type alsp the default\n - VirtualMachine: when we are running on virtual machine\n - BareMetalMachine: when we are running on physical hardware",
"type": "string"
},
"apiIoProfile": {
"default": "IO_PROFILE_SEQUENTIAL",
"enum": [
"IO_PROFILE_SEQUENTIAL",
"IO_PROFILE_RANDOM",
"IO_PROFILE_DB",
"IO_PROFILE_DB_REMOTE",
"IO_PROFILE_CMS",
"IO_PROFILE_SYNC_SHARED",
"IO_PROFILE_AUTO"
],
"type": "string"
},
"apiIoStrategy": {
"description": "IoStrategy defines how I/O should be performed to backing storage media.",
"properties": {
"async_io": {
"description": "AsyncIO enables kaio.",
"format": "boolean",
"type": "boolean"
},
"direct_io": {
"format": "boolean",
"title": "Enable direct I/O on the backing datastore",
"type": "boolean"
},
"early_ack": {
"description": "EarlyAck enables acks for async I/O at the source.",
"format": "boolean",
"type": "boolean"
}
},
"type": "object"
},
"apiJob": {
"properties": {
"clouddrive_transfer": {
"$ref": "#/components/schemas/apiCloudDriveTransferJob"
},
"create_time": {
"format": "date-time",
"title": "CreateTime is the time the job was created",
"type": "string"
},
"drain_attachments": {
"$ref": "#/components/schemas/apiNodeDrainAttachmentsJob"
},
"id": {
"title": "ID of the job",
"type": "string"
},
"last_update_time": {
"format": "date-time",
"title": "LastUpdateTime is the time the job was updated",
"type": "string"
},
"state": {
"$ref": "#/components/schemas/JobState"
},
"type": {
"$ref": "#/components/schemas/apiJobType"
}
},
"title": "Job is a generic job object that can encapsulate other\nmessages which follow the job framework of APIs",
"type": "object"
},
"apiJobSummary": {
"properties": {
"id": {
"title": "ID of the job",
"type": "string"
},
"total_runtime_seconds": {
"format": "uint64",
"title": "Total runtime in seconds",
"type": "string"
},
"work_summaries": {
"items": {
"$ref": "#/components/schemas/apiJobWorkSummary"
},
"title": "Summary provides more information about the on-going job",
"type": "array"
}
},
"title": "JobSummary provides a summary of a job",
"type": "object"
},
"apiJobType": {
"default": "UNSPECIFIED_TYPE",
"description": "- UNSPECIFIED_TYPE: Unspecified\n - NONE: None\n - DRAIN_ATTACHMENTS: Job for draining volume attachments\n - CLOUD_DRIVE_TRANSFER: Job for transferring cloud drives between nodes",
"enum": [
"UNSPECIFIED_TYPE",
"NONE",
"DRAIN_ATTACHMENTS",
"CLOUD_DRIVE_TRANSFER"
],
"title": "Type are the supported job types",
"type": "string"
},
"apiJobWorkSummary": {
"properties": {
"drain_attachments_summary": {
"$ref": "#/components/schemas/apiDrainAttachmentsSummary"
}
},
"title": "JobWorkSummary describes an action taken while performing the hob",
"type": "object"
},
"apiLabelSelectorRequirement": {