Cns Volume Manager Cns Delete Snapshots

Cns Volume Manager Cns Delete Snapshots

Delete snapshots with given volumeIds and snapshotIds.

Delete snapshot operation should be called by providing at least one SnapshotDeleteSpec If an array of empty spec is passed, the operation will fail. Return a task that tracks the status and result of delete operation per given volume. Following privileges will be required on specified entities, to perform this operation:

  • Datastore.FileManagement on all involved Datastores
Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/CnsVolumeManager/{moId}/CnsDeleteSnapshots
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case CnsVolumeManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
CnsDeleteSnapshotsRequestType of type(s) application/json
Required
"CnsDeleteSnapshotsRequestType Object"
array of object
snapshotDeleteSpecs
Required

Specifications for snapshot delete operation.

Delete the snapshot with given volumeId and snapshotId.

This structure may be used only with operations rendered under /vsan.

Authentication
This operation uses the following authentication methods.
Responses
200

Task to track the progress and result of this operation.

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

500

InvalidArgument: This API supports input size of 1 only. If more or less than one entries are passed as input, this exception will be thrown and operation will fail.
This exception will be thrown when invalid format for VolumeId id is passed, or volume IDs is empty etc.

NotFound: if the volume or snapshot can not be found.

CnsFault: Thrown for all other failure scenario.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/CnsVolumeManager/{moId}/CnsDeleteSnapshots