API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Dbs/2019-03-06) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Backup schedules
|
API |
Title |
Description |
| CreateBackupPlan | CreateBackupPlan | Creates a Database Backup Service (DBS) backup plan. |
| CreateAndStartBackupPlan | CreateAndStartBackupPlan | Creates, configures, and starts a backup plan. |
| StartBackupPlan | StartBackupPlan | This operation starts a DBS backup plan. |
| StopBackupPlan | StopBackupPlan | This operation pauses a DBS backup plan. |
| ModifyBackupObjects | ModifyBackupObjects | Modifies the objects included in a Database Backup Service (DBS) backup plan. |
| ModifyBackupSourceEndpoint | ModifyBackupSourceEndpoint | Modifies a DBS backup source endpoint. |
| ModifyBackupPlanName | ModifyBackupPlanName | Modifies the name of a backup plan. |
| DescribeBackupPlanList | DescribeBackupPlanList | Queries DBS backup plans. |
| DescribeBackupPlanBilling | DescribeBackupPlanBilling | This operation queries the billing information of a backup plan. |
| ConfigureBackupPlan | ConfigureBackupPlan | Configures a Database Backup (DBS) backup plan. |
| ReleaseBackupPlan | ReleaseBackupPlan | This operation releases a pay-as-you-go backup plan. |
Backup tasks
|
API |
Title |
Description |
| DescribeIncrementBackupList | DescribeIncrementBackupList | This operation queries the list of incremental backup tasks for DBS. |
| DescribeFullBackupList | DescribeFullBackupList | Lists full backup jobs in Database Backup (DBS). |
Restoration tasks
|
API |
Title |
Description |
| CreateRestoreTask | CreateRestoreTask | Creates a DBS restore task. |
| StartRestoreTask | StartRestoreTask | Starts a DBS restore job. |
| DescribeRestoreTaskList | DescribeRestoreTaskList | Queries restore jobs in Database Backup Service (DBS). |
Backup gateways
|
API |
Title |
Description |
| DescribeBackupGatewayList | DescribeBackupGatewayList | Queries a list of backup gateways in Database Backup Service (DBS). |
Backup set download
|
API |
Title |
Description |
| CreateFullBackupSetDownload | CreateFullBackupSetDownload | This operation creates a task to download a full backup set. |
| DescribeBackupSetDownloadTaskList | DescribeBackupSetDownloadTaskList | Queries the list of download tasks for backup sets in Database Backup Service (DBS). |
Service management
|
API |
Title |
Description |
| DescribeJobErrorCode | DescribeJobErrorCode | Queries error code information for a Database Backup (DBS) job. |
| DescribePreCheckProgressList | DescribePreCheckProgressList | This operation queries the precheck progress for a backup plan or a restore job. |
| DescribeRegions | DescribeRegions | Queries the regions where DBS is available. |
| InitializeDbsServiceLinkedRole | InitializeDbsServiceLinkedRole | Grants the service-linked role (AliyunServiceRoleForDBS) to Database Backup (DBS). |
Others
|
API |
Title |
Description |
| CreateGetDBListFromAgentTask | CreateGetDBListFromAgentTask | Creates a task to obtain a database list by using a backup gateway. |
| CreateIncrementBackupSetDownload | CreateIncrementBackupSetDownload | Creates and starts an incremental backup set download task. |
| DescribeDLAService | DescribeDLAService | Queries the status of the Data Lake Analytics (DLA) service for a backup schedule. |
| DescribeNodeCidrList | DescribeNodeCidrList | Queries the CIDR blocks of nodes on which Database Backup (DBS) is running. |
| DescribeRestoreRangeInfo | DescribeRestoreRangeInfo | This operation returns the time ranges available for restoring data from a backup plan. |
| DisableBackupLog | DisableBackupLog | Disable incremental backup for a backup plan. |
| EnableBackupLog | EnableBackupLog | Enable incremental backup for a backup schedule. |
| GetDBListFromAgent | GetDBListFromAgent | Queries the result of a task that is used to query a database list by using a backup gateway based on the ID of the task. |
| ModifyBackupSetDownloadRules | ModifyBackupSetDownloadRules | Enables, configures, or disables the automatic download feature. |
| ModifyBackupStrategy | ModifyBackupStrategy | Modifies the backup time of a backup schedule. |
| ModifyStorageStrategy | ModifyStorageStrategy | Modify the lifecycle of stored data in a backup plan. |
| RenewBackupPlan | RenewBackupPlan | Renews a backup schedule. |
| UpgradeBackupPlan | UpgradeBackupPlan | Upgrades a backup schedule. |