Snapservice. Clusters. Protection Groups Create$ Task

Snapservice. Clusters. Protection Groups Create$ Task

Create a protection group for the given cluster.

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 Host.Config.Storage.
Request
URI
POST
https://{host}/api/snapservice/clusters/{cluster}/protection-groups?vmw-task=true
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

Request Body

specification for the protection group.

Snapservice.ProtectionGroupSpec of type(s) application/json
Required 
"Snapservice.ProtectionGroupSpec Object"
Authentication
This operation uses the following authentication methods.
Responses
202

ID of newly-created protection group.

The response will be an identifier for the resource type: com.vmware.snapservice.protection_group.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi.Std.Errors.NotAllowedInCurrentState If there is another operation in progress.

Vapi.Std.Errors.InvalidArgument If validation of the spec fails.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error 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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/snapservice/clusters/{cluster}/protection-groups?vmw-task=true
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