Snapservice. Reports. Clusters. Protection Groups List

Snapservice. Reports. Clusters. Protection Groups List

List the protection groups for the given cluster used for reports. The list contains the protection groups existed over the last retention period which is used for reporting purpose, by default retention period is set to 90days.

This operation was added in vSphere API 9.0.0.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/reports/clusters/{cluster}/protection-groups
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the protection groups

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

400

If the API is not supported.

Returns Vapi.Std.Errors.Unsupported of type(s) application/json 
"Vapi.Std.Errors.Unsupported 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 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/reports/clusters/{cluster}/protection-groups
On This Page
Snapservice.reports.clusters.protection Groups Operations
GET
Snapservice. Reports. Clusters. Protection Groups List