Cleanup Failover Test Vm Replication

This request cleans up the VM replication test failover.

Request

URI

DELETE

https://{api_host}//vm-replications/{replicationId}/failover-test

COPY

Path Parameters

string

replicationId

Required

Cloud VM-level replication identifier

replicationId example

C4-ec991bd5-af9d-446a-8599-5b693842c4a3

Query Parameters

string

site

Optional

Optional site to run the operation on. When omitted, defaults to the local site.

site example

site1

Header Parameters

string

operationID

Optional

Operation ID for correlating logs across multiple services

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

Accepted

Returns C4ApiTask_of_SingleVmReplicationInfo 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": {
        "destination": {
            "org": "org2",
            "recoveredVappId": "null",
            "site": "site2",
            "vdcId": "5ee9224f-305d-46f6-865f-b605e70acef8",
            "vdcName": "Virtual DC 2"
        },
        "source": {
            "vappName": "vApp1"
        },
        "vappReplicationId": "C4VAPP-ccbe771e-b685-46c7-8c7a-4ed36915d963"
    },
    "resultType": "string",
    "site": "site2",
    "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 means the task hasn't completed.

ApiError

error

Optional

error

string As uuid As uuid

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.

SingleVmReplicationInfo

result

Optional

result

string

resultType

Optional

Indicates the type of the task result. Populated only if the execution was successful.

string

site

Optional

Site on which the task runs.

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, RemoteAuthenticationFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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.

404

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+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.5+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.