This product(
Dbs/2019-03-06) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Backup schedules
| API | Title | Description |
|---|---|---|
| CreateBackupPlan | CreateBackupPlan | Creates a backup schedule. |
| CreateAndStartBackupPlan | CreateAndStartBackupPlan | Creates, configures, and starts a backup schedule. |
| StartBackupPlan | StartBackupPlan | Starts a backup schedule. |
| EnableBackupLog | EnableBackupLog | Enables the incremental log backup feature for a backup schedule. |
| StopBackupPlan | StopBackupPlan | Stops a backup schedule. |
| DisableBackupLog | DisableBackupLog | Disables the incremental log backup feature for a backup schedule. |
| ModifyBackupObjects | ModifyBackupObjects | Modifies the backup objects of a backup schedule. |
| ModifyBackupSourceEndpoint | ModifyBackupSourceEndpoint | Modifies the information of a backup source. |
| ModifyStorageStrategy | ModifyStorageStrategy | Modifies the lifecycle of data that is backed up based on a backup schedule. |
| ModifyBackupPlanName | ModifyBackupPlanName | Changes the name of a backup schedule. |
| ModifyBackupStrategy | ModifyBackupStrategy | Modifies the backup time of a backup schedule. |
| DescribeBackupPlanList | DescribeBackupPlanList | Queries backup schedules. |
| DescribeRestoreRangeInfo | DescribeRestoreRangeInfo | Queries the details of time ranges to which you can restore data in a specified backup schedule. |
| DescribeBackupPlanBilling | DescribeBackupPlanBilling | Queries the billing information of a backup schedule. |
| ConfigureBackupPlan | ConfigureBackupPlan | Configures a backup schedule. |
| RenewBackupPlan | RenewBackupPlan | Renews a backup schedule. |
| UpgradeBackupPlan | UpgradeBackupPlan | Upgrades a backup schedule. |
| ReleaseBackupPlan | ReleaseBackupPlan | Releases a pay-as-you-go backup schedule. |
Backup tasks
| API | Title | Description |
|---|---|---|
| DescribeIncrementBackupList | DescribeIncrementBackupList | Queries incremental backup tasks. |
| DescribeFullBackupList | DescribeFullBackupList | Queries full backup tasks. |
Restoration tasks
| API | Title | Description |
|---|---|---|
| CreateRestoreTask | CreateRestoreTask | Creates a restore task. |
| StartRestoreTask | StartRestoreTask | Start a restore task. |
| DescribeRestoreTaskList | DescribeRestoreTaskList | Queries restore tasks. |
Backup gateways
| API | Title | Description |
|---|---|---|
| DescribeBackupGatewayList | DescribeBackupGatewayList | Queries backup gateways. |
Backup set download
| API | Title | Description |
|---|---|---|
| CreateFullBackupSetDownload | CreateFullBackupSetDownload | Creates and starts a full backup set download task. |
| CreateIncrementBackupSetDownload | CreateIncrementBackupSetDownload | Creates and starts an incremental backup set download task. |
| ModifyBackupSetDownloadRules | ModifyBackupSetDownloadRules | Enables, configures, or disables the automatic download feature. |
| DescribeBackupSetDownloadTaskList | DescribeBackupSetDownloadTaskList | Queries backup set download tasks. |
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 the standard error information of a Database Backup (DBS) task. |
| DescribePreCheckProgressList | DescribePreCheckProgressList | Queries the precheck progress for a backup schedule or a restore task. |
| DescribeDLAService | DescribeDLAService | Queries the status of the Data Lake Analytics (DLA) service 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. |
| DescribeRegions | DescribeRegions | Queries the regions that Database Backup (DBS) supports. |
| InitializeDbsServiceLinkedRole | InitializeDbsServiceLinkedRole | Grants the AliyunServiceRoleForDBS role to Database Backup (DBS). |