Deletes a backup plan

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.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteBackupPlan

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

PlanId String Yes plan-*********************

The ID of the backup plan.

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

The ID of the backup vault.

SourceType String No ECS_FILE

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.

Response parameters

Parameter Type Example Description
Code String 200

The status code 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=DeleteBackupPlan
&PlanId=plan-*********************
&VaultId=v-*********************
&<Common request parameters>

Sample success responses

XML format

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

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.