API standards and multilingual preset SDKs
The OpenAPI of this product (Dbs/2019-03-06) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Backup plan
|
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. |
| EnableBackupLog | EnableBackupLog | Enable incremental backup for a backup schedule. |
| StopBackupPlan | StopBackupPlan | This operation pauses a DBS backup plan. |
| DisableBackupLog | DisableBackupLog | Disable incremental backup for a backup plan. |
| ModifyBackupObjects | ModifyBackupObjects | Modifies the objects included in a Database Backup Service (DBS) backup plan. |
| ModifyBackupSourceEndpoint | ModifyBackupSourceEndpoint | Modify a DBS backup source endpoint. |
| ModifyStorageStrategy | ModifyStorageStrategy | Modify the lifecycle of stored data in a backup plan. |
| ModifyBackupPlanName | ModifyBackupPlanName | Modifies the name of a backup plan. |
| ModifyBackupStrategy | ModifyBackupStrategy | Modifies the backup time of a backup schedule. |
| DescribeBackupPlanList | DescribeBackupPlanList | Queries a DBS backup plan. |
| DescribeRestoreRangeInfo | DescribeRestoreRangeInfo | This operation returns the time ranges available for restoring data from a backup plan. |
| DescribeBackupPlanBilling | DescribeBackupPlanBilling | This operation queries the billing information of a backup plan. |
| ConfigureBackupPlan | ConfigureBackupPlan | Configures a Database Backup (DBS) backup plan. |
| RenewBackupPlan | RenewBackupPlan | Renews a backup schedule. |
| UpgradeBackupPlan | UpgradeBackupPlan | Upgrades a backup schedule. |
| ReleaseBackupPlan | ReleaseBackupPlan | This operation releases a pay-as-you-go backup plan. |
Backup task
|
API |
Title |
Description |
| DescribeIncrementBackupList | DescribeIncrementBackupList | This operation queries the list of incremental backup tasks for DBS. |
| DescribeFullBackupList | DescribeFullBackupList | This operation lists full backup jobs in Database Backup (DBS). |
Restore task
|
API |
Title |
Description |
| CreateRestoreTask | CreateRestoreTask | This operation creates a DBS restore task. |
| StartRestoreTask | StartRestoreTask | Starts a DBS restore job. |
| DescribeRestoreTaskList | DescribeRestoreTaskList | Queries restore jobs in Database Backup Service (DBS). |
Backup gateway
|
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. |
| CreateIncrementBackupSetDownload | CreateIncrementBackupSetDownload | Creates and starts an incremental backup set download task. |
| ModifyBackupSetDownloadRules | Set backup set download rules | Enables, modifies, or disables the automatic download feature. |
| DescribeBackupSetDownloadTaskList | DescribeBackupSetDownloadTaskList | Queries the list of download tasks for backup sets in Database Backup Service (DBS). |
Service management
|
API |
Title |
Description |
| CreateGetDBListFromAgentTask | CreateGetDBListFromAgentTask | Creates a task to obtain a database list by using a backup gateway. |
| DescribeNodeCidrList | DescribeNodeCidrList | Queries the CIDR blocks of nodes on which Database Backup (DBS) is running. |
| 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. |
| DescribeDLAService | DescribeDLAService | Queries the status of the Data Lake Analytics (DLA) service for a backup schedule. |
| GetDBListFromAgent | Retrieve database list by using a backup gateway | Retrieves database and table data from a physical backup by using a backup gateway. |
| InitializeDbsServiceLinkedRole | InitializeDbsServiceLinkedRole | Grants the service-linked role (AliyunServiceRoleForDBS) to Database Backup (DBS). |
Others
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the regions where DBS is available. |