@@ -15,8 +15,6 @@ servers:
1515tags :
1616 - name : ClusterRecordKeeping
1717 description : Everything about recording cluster details.
18- - name : DatastoreOperations
19- description : Operations invoked directly on datastores.
2018 - name : JobDetails
2119 description : Operations related to CNS manager asynchronous jobs.
2220 - name : OrphanVolume
@@ -149,51 +147,6 @@ paths:
149147 application/json :
150148 schema :
151149 $ref : ' #/components/schemas/Error'
152- /datastoreresources :
153- get :
154- tags :
155- - DatastoreOperations
156- summary : Get volumes(CNS & non-CNS) and virtual machines on a datastore.
157- description : " This API returns all the volumes(container volumes and non-CNS)\
158- \ as well as the virtual machines on a particular datastore.\n It is particularly\
159- \ useful to get this information while decommissioning a datastore. \n The\
160- \ fcd ids outputted from this API can then be used as an input parameter in\
161- \ MigrateVolumes API."
162- operationId : getDatastoreResources
163- parameters :
164- - name : datacenter
165- in : query
166- description : Datacenter name where the datastore is located. This input is
167- case-sensitive.
168- required : true
169- style : form
170- explode : true
171- schema :
172- type : string
173- format : string
174- - name : datastore
175- in : query
176- description : Name of the datastore on which container volumes need to be queried.
177- This input is case-sensitive.
178- required : true
179- style : form
180- explode : true
181- schema :
182- type : string
183- format : string
184- responses :
185- " 200 " :
186- description : Returns DatastoreResourcesResult.
187- content :
188- application/json :
189- schema :
190- $ref : ' #/components/schemas/DatastoreResourcesResult'
191- default :
192- description : unexpected error
193- content :
194- application/json :
195- schema :
196- $ref : ' #/components/schemas/Error'
197150 /getjobstatus :
198151 get :
199152 tags :
@@ -256,86 +209,6 @@ paths:
256209 application/json :
257210 schema :
258211 $ref : ' #/components/schemas/JobResult'
259- # TODO: check with Saloni about these endpoints
260- /suspendvolumeprovisioning :
261- post :
262- tags :
263- - DatastoreOperations
264- summary : Suspend Create Volume operation on datastore.
265- description : " This API will block creation of new File and Block volumes on the specified datastore. To unblock volume provisioning, invoke ResumeVolumeProvisioning API. \n \
266- Other volume operations like attach, detach, delete etc. will not get affected for existing volumes."
267- operationId : suspendVolumeProvisioning
268- parameters :
269- - name : datacenter
270- in : query
271- description : Datacenter name where the datastore is located. This input is case-sensitive.
272- required : true
273- style : form
274- explode : true
275- schema :
276- type : string
277- format : string
278- - name : datastore
279- in : query
280- description : Name of the datastore where creation of new volumes has to be blocked. This input is case-sensitive.
281- required : true
282- style : form
283- explode : true
284- schema :
285- type : string
286- format : string
287- responses :
288- " 200 " :
289- description : Returns SuspendVolumeProvisioningResult.
290- content :
291- application/json :
292- schema :
293- $ref : ' #/components/schemas/SuspendVolumeProvisioningResult'
294- default :
295- description : unexpected error
296- content :
297- application/json :
298- schema :
299- $ref : ' #/components/schemas/Error'
300- /resumevolumeprovisioning :
301- post :
302- tags :
303- - DatastoreOperations
304- summary : Resume Create Volume operation on datastore.
305- description : " This API will unblock creation of new File and Block volumes on the specified datastore. To block volume provisioning, invoke SuspendVolumeProvisioning API."
306- operationId : resumeVolumeProvisioning
307- parameters :
308- - name : datacenter
309- in : query
310- description : Datacenter name where the datastore is located. This input is case-sensitive.
311- required : true
312- style : form
313- explode : true
314- schema :
315- type : string
316- format : string
317- - name : datastore
318- in : query
319- description : Name of the datastore where creation of new volumes has to be resumed. This input is case-sensitive.
320- required : true
321- style : form
322- explode : true
323- schema :
324- type : string
325- format : string
326- responses :
327- " 200 " :
328- description : Returns ResumeVolumeProvisioningResult.
329- content :
330- application/json :
331- schema :
332- $ref : ' #/components/schemas/ResumeVolumeProvisioningResult'
333- default :
334- description : unexpected error
335- content :
336- application/json :
337- schema :
338- $ref : ' #/components/schemas/Error'
339212 /orphanvolumes :
340213 get :
341214 tags :
@@ -894,19 +767,6 @@ components:
894767 example :
895768 status : Deregistration Successful
896769 clusterId : cluster-1
897- FcdAttachmentDetails :
898- properties :
899- attached :
900- type : boolean
901- description : Indicates whether the volume is attached to a VM or not.
902- example : true
903- vm :
904- type : string
905- description : The name of VM to which the volume is attached.
906- example : k8s-node-1
907- example :
908- vm : k8s-node-1
909- attached : true
910770 JobResult :
911771 properties :
912772 jobId :
@@ -932,98 +792,6 @@ components:
932792 jobId : snapshotdeletionjob-d1e10795-700f-11ec-bcf8-8630aaccb28e
933793 jobStatus : " "
934794 jobParameters : " "
935- DatastoreResourcesResult :
936- properties :
937- datacenter :
938- type : string
939- description : Datacenter on which datastore resides.
940- example : VSAN-DC
941- datastore :
942- type : string
943- description : Datastore on which container volumes are being queried.
944- example : vsanDatastore
945- totalVolumes :
946- type : integer
947- description : The number of volumes on the datastore.
948- format : int64
949- example : 12
950- containerVolumes :
951- type : array
952- description : Array of CNS volumes with the FCD id and vm attachment details.
953- items :
954- $ref : ' #/components/schemas/VolumeDetails'
955- otherVolumes :
956- type : array
957- description : Array of non-CNS volumes with the FCD id and vm attachment
958- details.
959- items :
960- $ref : ' #/components/schemas/VolumeDetails'
961- virtualMachines :
962- type : array
963- description : Array of virtual machines on the datastore.
964- items :
965- $ref : ' #/components/schemas/VMDetails'
966- example :
967- totalVolumes : 12
968- datastore : vsanDatastore
969- otherVolumes :
970- - null
971- - null
972- datacenter : VSAN-DC
973- containerVolumes :
974- - attachmentDetails :
975- vm : k8s-node-1
976- attached : true
977- fcdName : pvc-338934c2-6067-489a-a929-7c559ea18c82
978- host : 10.187.143.84
979- fcdId : 64d6787e-397b-4c99-a151-c6f37c49fcff
980- - attachmentDetails :
981- vm : k8s-node-1
982- attached : true
983- fcdName : pvc-338934c2-6067-489a-a929-7c559ea18c82
984- host : 10.187.143.84
985- fcdId : 64d6787e-397b-4c99-a151-c6f37c49fcff
986- virtualMachines :
987- - vmName : k8s-worker1
988- vmId : vm-41
989- - vmName : k8s-worker1
990- vmId : vm-41
991- VolumeDetails :
992- properties :
993- fcdId :
994- type : string
995- description : ID of the FCD.
996- example : 64d6787e-397b-4c99-a151-c6f37c49fcff
997- fcdName :
998- type : string
999- description : Name of the FCD.
1000- example : pvc-338934c2-6067-489a-a929-7c559ea18c82
1001- attachmentDetails :
1002- $ref : ' #/components/schemas/FcdAttachmentDetails'
1003- host :
1004- type : string
1005- description : Host owning the node vm to which the volume is attached.
1006- example : 10.187.143.84
1007- example :
1008- attachmentDetails :
1009- vm : k8s-node-1
1010- attached : true
1011- fcdName : pvc-338934c2-6067-489a-a929-7c559ea18c82
1012- host : 10.187.143.84
1013- fcdId : 64d6787e-397b-4c99-a151-c6f37c49fcff
1014- VMDetails :
1015- properties :
1016- vmName :
1017- type : string
1018- description : Name of the virtual machine.
1019- example : k8s-worker1
1020- vmId :
1021- type : string
1022- description : Id of the virtual machine.
1023- example : vm-41
1024- example :
1025- vmName : k8s-worker1
1026- vmId : vm-41
1027795 Fault :
1028796 properties :
1029797 message :
@@ -1034,22 +802,6 @@ components:
1034802 type : string
1035803 description : Type of fault.
1036804 example : CnsFault
1037- SuspendVolumeProvisioningResult :
1038- properties :
1039- message :
1040- type : string
1041- description : Result of suspending volume provisioning on datastore.
1042- example : " Successfully suspended volume provisioning on datastore nfs0-1."
1043- example :
1044- message : Successfully suspended volume provisioning on datastore nfs0-1.
1045- ResumeVolumeProvisioningResult :
1046- properties :
1047- message :
1048- type : string
1049- description : Result of resuming volume provisioning on datastore.
1050- example : " Successfully resumed volume provisioning on datastore nfs0-1."
1051- example :
1052- message : Successfully resumed volume provisioning on datastore nfs0-1.
1053805 OrphanVolumeDetails :
1054806 type : object
1055807 description : OrphanVolumeDetails represents if the orphan volume is attached to a VM or not.
0 commit comments