API概览

本产品(数据库备份/2019-03-06)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

备份计划

API标题API概述
CreateBackupPlan创建备份计划创建一个DBS备份计划。
CreateAndStartBackupPlan创建并启动备份计划创建、配置备份计划并启动。
StartBackupPlan启动备份计划调动StartBackupPlan接口,启动一个DBS备份计划。
EnableBackupLog开启增量备份调用EnableBackupLog接口,开启备份计划中的增量备份。
StopBackupPlan暂停备份计划调用StopBackupPlan接口,暂停一个DBS备份计划。
DisableBackupLog关闭增量备份调用DisableBackupLog接口,关闭备份计划中的增量备份。
ModifyBackupObjects修改备份对象调用ModifyBackupObjects接口,修改一个DBS备份计划的备份对象。
ModifyBackupSourceEndpoint修改数据库备份源调用ModifyBackupSourceEndpoint接口,修改数据库备份源。
ModifyStorageStrategy修改存储数据的生命周期调用ModifyStorageStrategy接口,修改备份计划中的存储数据的生命周期。
ModifyBackupPlanName修改备份计划名称调用ModifyBackupPlanName接口,修改一个备份计划名称。
ModifyBackupStrategy修改备份时间调用ModifyBackupStrategy接口,修改一个DBS备份计划的备份时间。
DescribeBackupPlanList查看备份计划调用DescribeBackupPlanList接口,查看一个DBS备份计划。
DescribeRestoreRangeInfo查看可恢复时间段详情调用DescribeRestoreRangeInfo接口,查看一个备份计划可恢复时间段详情。
DescribeBackupPlanBilling查看备份计划计费信息调用DescribeBackupPlanBilling接口,查看备份计划计费信息。
ConfigureBackupPlan配置备份计划调用ConfigureBackupPlan接口,配置一个DBS备份计划。
RenewBackupPlan续费备份计划调用RenewBackupPlan接口,续费一个DBS备份计划。
UpgradeBackupPlan升级备份计划调用UpgradeBackupPlan接口,升级一个DBS备份计划。
ReleaseBackupPlan释放按量付费的备份计划调用ReleaseBackupPlan接口,释放一个按量付费的备份计划。

备份任务

API标题API概述
DescribeIncrementBackupList查看增量备份任务列表调用DescribeIncrementBackupList接口,查看DBS增量备份任务列表。
DescribeFullBackupList查看全量备份任务列表调用DescribeFullBackupList接口,查看DBS全量备份任务列表。

恢复任务

API标题API概述
CreateRestoreTask创建恢复任务调用CreateRestoreTask接口,创建DBS恢复任务。
StartRestoreTask启动恢复任务调用StartRestoreTask接口,启动一个DBS恢复任务。
DescribeRestoreTaskList查看恢复任务列表调用DescribeRestoreTaskList接口,查看DBS恢复任务列表。

备份网关

API标题API概述
DescribeBackupGatewayList查看备份网关列表调用DescribeBackupGatewayList接口,查看DBS备份网关列表。

备份集下载

API标题API概述
CreateFullBackupSetDownload创建全量备份集下载任务调用CreateFullBackupSetDownload接口,创建并启动全量备份集下载任务。
CreateIncrementBackupSetDownload创建增量备份集下载任务调用CreateIncrementBackupSetDownload接口,创建并启动增量备份集下载任务。
ModifyBackupSetDownloadRules设置备份集下载规则调用ModifyBackupSetDownloadRules接口,开启、修改、关闭自动下载功能。
DescribeBackupSetDownloadTaskList查看备份集下载列表调用DescribeBackupSetDownloadTaskList接口,查看DBS备份集下载列表。

服务管理

API标题API概述
CreateGetDBListFromAgentTask创建数据库列表任务调用CreateGetDBListFromAgentTask接口,通过备份网关获取数据库列表任务。
DescribeNodeCidrList查看DBS运行节点网段调用DescribeNodeCidrList接口,查看DBS运行节点网段列表。
DescribeJobErrorCode查看任务错误码信息调用DescribeJobErrorCode接口,查看DBS任务错误码信息。
DescribePreCheckProgressList查看预检查进度列表调用DescribePreCheckProgressList接口,查看备份计划预检查进度和恢复任务预检查进度。
DescribeDLAService查看数据查询服务(DLA)调用DescribeDLAService接口,查看备份计划的数据查询服务(DLA)。
GetDBListFromAgent通过备份网关获取数据库列表调用GetDBListFromAgent接口,通过备份网关获取物理备份的库表数据。
DescribeRegions查看DBS支持地域调用DescribeRegions接口,查看DBS支持地域。
InitializeDbsServiceLinkedRole授权DBS服务关联角色调用InitializeDbsServiceLinkedRole接口,将服务关联角色(AliyunServiceRoleForDBS)授权给DBS。
阿里云首页 数据库备份 DBS 相关技术圈