Snapservice. Clusters. Protection Groups. Snapshots List

Snapservice. Clusters. Protection Groups. Snapshots List

List the snapshots for the given protection group.

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}/protection-groups/{pg}/snapshots
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

string
pg
Required

Identifier of the protection group.

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

Query Parameters
Snapservice.Clusters.ProtectionGroups.Snapshots.FilterSpec
filter
Optional

Specification of matching snapshots for which information should be returned.

If missing or null, the behavior is equivalent to a Snapservice.Clusters.ProtectionGroups.Snapshots.FilterSpec with all properties missing or null which means all protection group snapshots match the filter. Snapservice.Clusters.ProtectionGroups.Snapshots.FilterSpec for the specified protection group.

string of array
snapshots
Optional

Identifiers of the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot.

string of array
names
Optional

Names of the snapshots that must match the filter.

This property was added in vSphere API 8.0.3.0.

If missing or null snapshots with any name match the filter.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the snapshots matching the

Returns Snapservice.Clusters.ProtectionGroups.Snapshots.ListResult of type(s) application/json 
"Snapservice.Clusters.ProtectionGroups.Snapshots.ListResult Object"

400

If validation of the filter fails.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json 
"Vapi.Std.Errors.InvalidArgument 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 there is no cluster associated with cluster or no or no protection group associated with pgin 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}/protection-groups/{pg}/snapshots
On This Page
Snapservice.clusters.protection Groups.snapshots Operations
GET
Snapservice. Clusters. Protection Groups. Snapshots List
GET
Snapservice. Clusters. Protection Groups. Snapshots Get
DELETE
Snapservice. Clusters. Protection Groups. Snapshots Delete
POST
Snapservice. Clusters. Protection Groups. Snapshots Create$ Task