All Products
Search
Document Center

StopBackupPlan

Last Updated: Mar 18, 2020

Description

You can call this operation to stop a DBS backup schedule.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to StopBackupPlan.
BackupPlanId String Yes The ID of the backup schedule.
StopMethod String Yes The method that you want to use to stop the backup schedule. Valid values:
  • ALL: Stop the backup schedule, full data backup tasks, incremental log backup tasks, and restore tasks.
  • PLAN: Stop only the backup schedule.

Response parameters

Parameter Type Description
BackupPlanId String The ID of the backup schedule.

Error codes

Error code Error message Description
BackupPlanNotStop Backup Plan not stop. The error message returned because the backup schedule cannot be stopped.