Cancels a restore job.

Request parameters

Parameter Type Required Example Description
Action String Yes CancelRestoreJob

The operation that you want to perform. Set the value to CancelRestoreJob.

RestoreId String Yes r-*********************

The ID of the restore job.

VaultId String Yes v-*********************

The ID of the backup vault.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. The value 200 indicates that the request is successful.

Message String successful

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CancelRestoreJob
&RestoreId=r-*********************
&VaultId=v-*********************
&<Common request parameters>

Sample success responses

XML format 

<CancelRestoreJobResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</CancelRestoreJobResponse>

JSON format 

{
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "Code": 200,
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.