All Products
Document Center


Last Updated: Mar 18, 2020


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

The DBS instance starts working after you call the CreateBackupPlan operation. Then, you have to wait 5 seconds in most cases before calling the ConfigureBackupPlan operation.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to CreateBackupPlan.
Region String Yes The region of the DBS instance. Valid values:
  • cn-hangzhou: Alibaba Cloud of China (Hangzhou)
  • cn-shanghai: Alibaba Cloud of China (Shanghai)
  • cn-qingdao: Alibaba Cloud of China (Qingdao)
  • cn-beijing: Alibaba Cloud of China (Beijing)
  • cn-shenzhen: Alibaba Cloud of China (Shenzhen)
  • cn-hongkong: Alibaba Cloud of China (Hong Kong)
  • ap-southeat-1: Alibaba Cloud of Singapore
  • cn-hangzhou-finance: Finance Cloud of China (Hangzhou)
  • cn-shanghai-finance: Finance Cloud of China (Shanghai)
  • cn-shenzhen-finance: Finance Cloud of China (Shenzhen)
DatabaseType String Yes The type of the database. Valid values:
  • MySQL
  • Oracle
  • MongoDB
  • Redis
InstanceClass String Yes The type of the DBS instance. Valid values:
  • micro
  • small
  • medium
  • large
BackupMethod String Yes The backup method that you want to use. Valid values:
  • logical
  • physical
  • duplication
Period String Yes Specifies whether to subscribe to the instance by year or by month. Valid values:
  • Year
  • Month.
UsedTime Integer Yes The subscription duration.
  • If Period is set to Year, the value of this parameter ranges from 1 to 9.
  • If Period is set to Month, the value of this parameter ranges from 1 to 11.
ClientToken String No The token used to guarantee the idempotence of the request. It can be any string.

Response parameters

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

Error codes

Error code Error message Description
BackupPlanNotCreate Backup Plan not create. The error message returned because the backup schedule cannot be created.