API标准及多语言预置SDK
本产品（Dbs/2019-03-06）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
备份计划
|
API |
标题 |
API概述 |
| CreateBackupPlan | 创建备份计划 | 该接口用于创建一个DBS备份计划。 |
| CreateAndStartBackupPlan | 创建并启动备份计划 | 该接口用于创建、配置并启动备份计划。 |
| StartBackupPlan | 启动备份计划 | 该接口用于启动一个DBS备份计划。 |
| EnableBackupLog | 开启增量备份 | 该接口用于开启备份计划中的增量备份。 |
| StopBackupPlan | 暂停备份计划 | 该接口用于暂停一个DBS备份计划。 |
| DisableBackupLog | 关闭增量备份 | 该接口用于关闭备份计划中的增量备份。 |
| ModifyBackupObjects | 修改备份对象 | 该接口用于修改一个DBS备份计划的备份对象。 |
| ModifyBackupSourceEndpoint | 修改数据库备份源 | 该接口用于修改数据库备份源。 |
| ModifyStorageStrategy | 修改存储数据的生命周期 | 该接口用于修改备份计划中的存储数据的生命周期。 |
| ModifyBackupPlanName | 修改备份计划名称 | 该接口用于修改一个备份计划名称。 |
| ModifyBackupStrategy | 修改备份时间 | 该接口用于修改备份计划的备份时间。 |
| DescribeBackupPlanList | 查看备份计划 | 该接口用于查看一个DBS备份计划。 |
| DescribeRestoreRangeInfo | 查看可恢复时间段详情 | 该接口用于查看一个备份计划可恢复时间段详情。 |
| DescribeBackupPlanBilling | 查看备份计划计费信息 | 该接口用于查看备份计划计费信息。 |
| ConfigureBackupPlan | 配置备份计划 | 该接口用于配置一个DBS备份计划。 |
| RenewBackupPlan | 续费备份计划 | 该接口用于续费一个DBS备份计划。 |
| UpgradeBackupPlan | 升级备份计划 | 该接口用于升级一个DBS备份计划。 |
| ReleaseBackupPlan | 释放备份计划 | 该接口仅支持释放一个按量付费的备份计划。 |
备份任务
|
API |
标题 |
API概述 |
| DescribeIncrementBackupList | 查看增量备份任务列表 | 该接口用于查看DBS增量备份任务列表。 |
| DescribeFullBackupList | 查看全量备份任务列表 | 该接口用于查看DBS全量备份任务列表。 |
恢复任务
|
API |
标题 |
API概述 |
| CreateRestoreTask | 创建恢复任务 | 该接口用于创建DBS恢复任务。 |
| StartRestoreTask | 启动恢复任务 | 该接口用于启动一个DBS恢复任务。 |
| DescribeRestoreTaskList | 查看恢复任务列表 | 该接口用于查看DBS恢复任务列表。 |
备份网关
|
API |
标题 |
API概述 |
| DescribeBackupGatewayList | 查看备份网关列表 | 该接口用于查看DBS备份网关列表。 |
备份集下载
|
API |
标题 |
API概述 |
| CreateFullBackupSetDownload | 创建全量备份集下载任务 | 该接口用于创建并启动全量备份集下载任务。 |
| CreateIncrementBackupSetDownload | 创建增量备份集下载任务 | 该接口用于创建并启动增量备份集下载任务。 |
| ModifyBackupSetDownloadRules | 设置备份集下载规则 | 该接口用于开启、修改、关闭自动下载功能。 |
| DescribeBackupSetDownloadTaskList | 查看备份集下载列表 | 该接口用于查看DBS备份集下载列表。 |
服务管理
|
API |
标题 |
API概述 |
| CreateGetDBListFromAgentTask | 创建数据库列表任务 | 该接口用于通过备份网关获取数据库列表任务。 |
| DescribeNodeCidrList | 查看DBS运行节点网段 | 该接口用于查看DBS运行节点网段列表。 |
| DescribeJobErrorCode | 查看任务错误码信息 | 该接口用于查看DBS任务错误码信息。 |
| DescribePreCheckProgressList | 查看预检查进度列表 | 该接口用于查看备份计划预检查进度和恢复任务预检查进度。 |
| DescribeDLAService | 查看数据查询服务（DLA） | 该接口用于查看备份计划的数据查询服务（DLA）。 |
| GetDBListFromAgent | 通过备份网关获取数据库列表 | 该接口用于通过备份网关获取物理备份的库表数据。 |
| DescribeRegions | 查看DBS支持地域 | 该接口用于查看DBS支持地域。 |
| InitializeDbsServiceLinkedRole | 授权DBS服务关联角色 | 该接口用于将服务关联角色（AliyunServiceRoleForDBS）授权给DBS。 |
该文章对您有帮助吗？