All Products
Search
Document Center

Hybrid Backup Recovery:CancelBackupJob

Last Updated:Nov 14, 2022

Cancels a backup job.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the backup job.

j-******************************
VaultIdstringYes

The ID of the backup vault.

v-*****************************

Response parameters

ParameterTypeDescriptionExample
object
Codestring

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

200
Messagestring

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.

successful
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the request is successful. Valid values:

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

Example

Request example

http(s)://[Endpoint]/?Action=CancelBackupJob
&JobId=j-******************************
&VaultId=v-*****************************
&<Common request parameters>

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.