[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
Cancel Recovery Plan
DescriptionCancels a running recovery task for this recovery plan.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/cancel
Path Parameters
Path Parameters
string
pairing_id
Required
The ID of a pairing between this Site Recovery Manager server and remote one
string
plan_id
Required
The ID of a recovery plan defined within current pairing
Authentication
This operation uses the following authentication methods.
Errors
ResponseError
400
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
401
Unauthorized - the client must authenticate itself to get the requested response
ResponseError
403
Forbidden - not sufficient access rights to fulfill the request
404
Not Found - server cannot find the requested in URL resource
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
Invoke-SrmCancelRecoveryPlan -pairingId "MypairingId" -planId "MyplanId"
cURL Command
curl -X POST https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/cancel
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- VcDr.RecoveryProfile.com.vmware.vcDr.Failover
- VcDr.RecoveryProfile.com.vmware.vcDr.Run
x-dr-remote-site-connectivity-contract:
not-authenticated: ERROR
server-down: DEPENDS_ON_PROVIDED_PARAMS
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
On This Page
Recovery Operations
post
post
delete
post
post
post
