Snapservice. Cluster Pairs Delete$ Task

Snapservice. Cluster Pairs Delete$ Task

Delete the specified cluster-pair.

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:

  • Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.Manage.
Request
URI
DELETE
https://{host}/api/snapservice/cluster-pairs/{cp}?vmw-task=true
COPY
Path Parameters
string
cp
Required

ClusterPair identifier.

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

Authentication
This operation uses the following authentication methods.
Responses
202

Success!

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

400

If caller tries to delete the cluster-pair with active protection groups.

Returns Vapi.Std.Errors.NotAllowedInCurrentState of type(s) application/json 
"Vapi.Std.Errors.NotAllowedInCurrentState 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 the cp is not found.

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 system is unable to communicate with a service to complete the request.

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

Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/snapservice/cluster-pairs/{cp}?vmw-task=true
On This Page
Snapservice.cluster Pairs Operations
GET
Snapservice. Cluster Pairs List
GET
Snapservice. Cluster Pairs Get
POST
Snapservice. Cluster Pairs Create Precheck
POST
Snapservice. Cluster Pairs Create$ Task
DELETE
Snapservice. Cluster Pairs Delete$ Task
POST
Snapservice. Cluster Pairs Create Precheck$ Task