This topic describes the API operations supported by OpenAPI.
Backup Schedule
| API | Description |
|---|---|
| CreateBackupPlan | Create a backup plan |
| ConfigureBackupPlan | Configure a backup schedule |
| RenewBackupPlan | Renew a backup plan |
| UpgradeBackupPlan | Upgrade a backup plan |
| DescribeBackupPlanList | View a backup plan |
| StartBackupPlan | Start a backup schedule |
| StopBackupPlan | Pause a backup plan |
| ModifyBackupObjects | Modify a backup object |
| EnableBackupLog | Enable incremental backup |
| DisableBackupLog | Disable incremental backup |
| ReleaseBackupPlan | Release a pay-as-you-go backup schedule |
| ModifyStorageStrategy | Modify the lifecycle of stored data |
| ModifyBackupSourceEndpoint | Modify the database backup source |
| ModifyBackupPlanName | Modify the name of a backup plan |
| ModifyBackupStrategy | Modify the backup time |
| DescribeRestoreRangeInfo | View recovery time range details |
| DescribeBackupPlanBilling | View the billing information of a backup schedule |
Back up node code
| API | Description |
|---|---|
| DescribeFullBackupList | View the list of full backup jobs |
| DescribeIncrementBackupList | View incremental backup tasks |
Resume a job
| API | Description |
|---|---|
| CreateRestoreTask | Create a restoration job |
| StartRestoreTask | Start a recovery task |
| DescribeRestoreTaskList | View the recovery task list |
Backup Gateways
| API | Description |
|---|---|
| DescribeBackupGatewayList | View the backup gateway list |
Others
| API | Description |
|---|---|
| DescribeNodeCidrList | View the CIDR blocks of DBS nodes |
| DescribeJobErrorCode | View the node standardization error codes |
| DescribePreCheckProgressList | View the pre-check progress list |
| CreateGetDBListFromAgentTask | Create a task to obtain the database list through the backup gateway |
| GetDBListFromAgent | Obtain the database list through the backup Gateway |
| DescribeRegions | Supported regions |
Download backup sets
| API | Description |
|---|---|
| DescribeBackupSetDownloadTaskList | View the download list of backup sets |
| ModifyBackupSetDownloadRules | Set rules for downloading Backup sets |
| CreateFullBackupSetDownload | Create a full backup set download task |
| CreateIncrementBackupSetDownload | Create an incremental backup set download task |