Cleanup Failover Test Recovery Plan

Cleanup Failover Test Recovery Plan

This request cleans up the VM replication test failover for the specified recovery plan.

The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

Request
URI
DELETE
https://{api_host}/recovery-plans/{recoveryPlanId}/test
COPY
Path Parameters
string
recoveryPlanId
Required

ID of the recovery plan.

recoveryPlanId example 
e7bf7128-2825-48ca-9075-3f496de70ffe
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns ApiTask_of_RecoveryPlanInfo of type(s) application/json;charset=UTF-8 
{
    "endTime": 1499929558827,
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "result": {
        "description": "Example of a plan",
        "displayName": "Plan 1",
        "executionInfo": {
            "isSuspendRequested": false,
            "lastError": {
                "args": [],
                "code": "Forbidden",
                "msg": "Permission denied.",
                "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
            },
            "lastOperation": "string",
            "promptStepId": "5ee9224f-305d-46f6-865f-b605e70acef8",
            "state": "string"
        },
        "id": "2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
        "isMigration": false,
        "owner": "org1@site1",
        "scheduledSyncTime": 1901071800000
    },
    "resultType": "string",
    "startTime": 1499929548951,
    "state": "string",
    "user": "root",
    "warnings": [],
    "workflowInfo": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

RecoveryPlanInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Recovery Plans Operations
POST
Add Recovery Plan Step
POST
Chown Recovery Plan
DELETE
Cleanup Failover Test Recovery Plan
POST
Clone Recovery Plan
GET
Cloud Recovery Plans
POST
Create Recovery Plans
DELETE
Delete Recovery Plan
DELETE
Delete Recovery Plan Step
POST
Failover Recovery Plan
GET
Get Recovery Plan
GET
Get Recovery Plan Report
GET
Get Recovery Plan Step
GET
Get Recovery Plan Steps
POST
Migrate Recovery Plan
POST
Recovery Plan Execution Cookie
GET
Recovery Plan Executions
POST
Reorder Recovery Plan Step
POST
Schedule Recovery Plan Sync
POST
Suspend Recovery Plan
POST
Test Recovery Plan
PATCH
Update Recovery Plan
PATCH
Update Recovery Plan Step