All Products
Search
Document Center

Hybrid Backup Recovery:DeleteBackupPlan

Last Updated:Nov 14, 2022

Deletes a backup plan.

Operation Description

  • If you delete a backup plan, all backup jobs that are related to the backup plan are deleted.
  • The backup files that you create are retained.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PlanIdstringYes

The ID of the backup plan.

plan-*********************
VaultIdstringYes

The ID of the backup vault.

v-*********************
SourceTypestringNo

The type of the data source. Valid values:

  • ECS_FILE: The system backs up data from Elastic Compute Service (ECS) instances.
  • OSS: The system backs up data from Object Storage Service (OSS) buckets.
  • NAS: The system backs up data from Apsara File Storage NAS file systems.
ECS_FILE

Response parameters

ParameterTypeDescriptionExample
object

The reponse body.

Codestring

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=DeleteBackupPlan
&PlanId=plan-*********************
&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.