Snapservice. Clusters. Virtual Machines. Snapshots Get

Snapservice. Clusters. Virtual Machines. Snapshots Get

Get the detailed information regarding the specified virtual machine snapshot.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.
Request
URI
GET
https://{host}/api/snapservice/clusters/{cluster}/virtual-machines/{vm}/snapshots/{snapshot}
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

string
vm
Required

Identifier of the virtual machine.

The parameter must be an identifier for the resource type: VirtualMachine.

string
snapshot
Required

Identifier of the virtual machine snapshot.

The parameter must be an identifier for the resource type: com.vmware.snapservice.vm.snapshot.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the virtual mahcine snapshot.

Returns Snapservice.Clusters.VirtualMachines.Snapshots.Info of type(s) application/json 
"Snapservice.Clusters.VirtualMachines.Snapshots.Info Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json 
"Vapi.Std.Errors.Unauthorized Object"

404

If no cluster associated with cluster or no virtual machine associated with vm or no snapshot associated with snapshot is found in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/snapservice/clusters/{cluster}/virtual-machines/{vm}/snapshots/{snapshot}
On This Page
Snapservice.clusters.virtual Machines.snapshots Operations
GET
Snapservice. Clusters. Virtual Machines. Snapshots List
GET
Snapservice. Clusters. Virtual Machines. Snapshots Get