appliance recovery restore job: cancel

Cancel the backup job

Request:

HTTP request

POST https://{server}/rest/appliance/recovery/restore/job/cancel
No request parameters

Response:

HTTP Status Code: 200

Representations:

{
    "value"{
        "messages"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            }
        ],
        "status""FAIL"
    }
}
<?xml version="1.0" ?>
<ns0:Cancel-Result xmlns:ns0="http://vmware.com/appliance/recovery/restore/job" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <status>FAIL</status>
    <messages-array>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
    </messages-array>
  </value>
</ns0:Cancel-Result>

Response Type:

Name Type Description
bold = required
value return_result RestoreJobStatus Structure.
value.status string Check status

Defines the state of precheck Value is one of:
FAIL: Check failed
WARNING: Passed with warnings
OK: Check passed

value.messages localizable_message[] List of messages

value.messages[].id string id in message bundle

value.messages[].default_message string text in english

value.messages[].args string[] nested data

Errors:

HTTP Status Code Type Description
500 error Generic error