Snapservice. Clusters. Protection Groups Get

Snapservice. Clusters. Protection Groups Get

Get the detailed information regarding the specified 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}
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.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the specified protection group.

Returns Snapservice.ProtectionGroupInfo of type(s) application/json 
"Snapservice.ProtectionGroupInfo Object"

400

If any input is invalid.

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 no cluster associated with cluster or protection group associated with pg 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}/protection-groups/{pg}
On This Page
Snapservice.clusters.protection Groups Operations
GET
Snapservice. Clusters. Protection Groups List
GET
Snapservice. Clusters. Protection Groups Get
POST
Snapservice. Clusters. Protection Groups Create$ Task
DELETE
Snapservice. Clusters. Protection Groups Delete$ Task
PATCH
Snapservice. Clusters. Protection Groups Update$ Task
POST
Snapservice. Clusters. Protection Groups Pause$ Task
POST
Snapservice. Clusters. Protection Groups Resume$ Task
POST
Snapservice. Clusters. Protection Groups Demote$ Task
POST
Snapservice. Clusters. Protection Groups Promote$ Task
POST
Snapservice. Clusters. Protection Groups Activate$ Task