All Products
Document Center

Database Backup:List of operations by function

Last Updated:Jun 13, 2024
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

CreateBackupPlanCreateBackupPlanCreates a backup schedule.
CreateAndStartBackupPlanCreateAndStartBackupPlanCreates, configures, and starts a backup schedule.
StartBackupPlanStartBackupPlanStarts a backup schedule.
EnableBackupLogEnableBackupLogEnables the incremental log backup feature for a backup schedule.
StopBackupPlanStopBackupPlanStops a backup schedule.
DisableBackupLogDisableBackupLogDisables the incremental log backup feature for a backup schedule.
ModifyBackupObjectsModifyBackupObjectsModifies the backup objects of a backup schedule.
ModifyBackupSourceEndpointModifyBackupSourceEndpointModifies the information of a backup source.
ModifyStorageStrategyModifyStorageStrategyModifies the lifecycle of data that is backed up based on a backup schedule.
ModifyBackupPlanNameModifyBackupPlanNameChanges the name of a backup schedule.
ModifyBackupStrategyModifyBackupStrategyModifies the backup time of a backup schedule.
DescribeBackupPlanListDescribeBackupPlanListQueries backup schedules.
DescribeRestoreRangeInfoDescribeRestoreRangeInfoQueries the details of time ranges to which you can restore data in a specified backup schedule.
DescribeBackupPlanBillingDescribeBackupPlanBillingQueries the billing information of a backup schedule.
ConfigureBackupPlanConfigureBackupPlanConfigures a backup schedule.
RenewBackupPlanRenewBackupPlanRenews a backup schedule.
UpgradeBackupPlanUpgradeBackupPlanUpgrades a backup schedule.
ReleaseBackupPlanReleaseBackupPlanReleases a pay-as-you-go backup schedule.

Backup tasks

DescribeIncrementBackupListDescribeIncrementBackupListQueries incremental backup tasks.
DescribeFullBackupListDescribeFullBackupListQueries full backup tasks.

Restoration tasks

CreateRestoreTaskCreateRestoreTaskCreates a restoration task.
StartRestoreTaskStartRestoreTaskStarts a restore task.
DescribeRestoreTaskListDescribeRestoreTaskListQueries restore tasks.

Backup gateways

DescribeBackupGatewayListDescribeBackupGatewayListQueries backup gateways.

Backup set download

CreateFullBackupSetDownloadCreateFullBackupSetDownloadCreates and starts a full backup set download task.
CreateIncrementBackupSetDownloadCreateIncrementBackupSetDownloadCreates and starts an incremental backup set download task.
ModifyBackupSetDownloadRulesModifyBackupSetDownloadRulesEnables, configures, or disables the automatic download feature.
DescribeBackupSetDownloadTaskListDescribeBackupSetDownloadTaskListQueries backup set download tasks.

Service management

CreateGetDBListFromAgentTaskCreateGetDBListFromAgentTaskCreates a task to obtain a database list by using a backup gateway.
DescribeNodeCidrListDescribeNodeCidrListQueries the CIDR blocks of nodes on which Database Backup (DBS) is running.
DescribeJobErrorCodeDescribeJobErrorCodeQueries the error information of a Database Backup (DBS) task.
DescribePreCheckProgressListDescribePreCheckProgressListQueries the precheck progress of a backup schedule or a restore task.
DescribeDLAServiceDescribeDLAServiceQueries the status of the Data Lake Analytics (DLA) service for a backup schedule.
GetDBListFromAgentGetDBListFromAgentQueries 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.
DescribeRegionsDescribeRegionsQueries the regions that Database Backup (DBS) supports.
InitializeDbsServiceLinkedRoleInitializeDbsServiceLinkedRoleGrants the AliyunServiceRoleForDBS role to Database Backup (DBS).