本产品（
云备份 Cloud Backup/2017-09-08）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
备份仓库
| API | 标题 | API概述 |
|---|---|---|
| CreateVault | 创建备份仓库 | 创建一个备份仓库。 |
| CreateReplicationVault | 创建镜像备份仓库 | 创建一个镜像备份仓库。 |
| DeleteVault | 删除备份仓库 | 删除一个备份仓库。 |
| UpdateVault | 更新备份仓库的配置信息 | 更新备份仓库的配置信息。 |
| DescribeVaults | 查询备份仓库信息 | 获取一个或者多个符合条件的备份仓库信息。 |
备份计划
| API | 标题 | API概述 |
|---|---|---|
| CreateBackupPlan | 创建备份计划 | 创建一个备份计划。 |
| DeleteBackupPlan | 删除备份计划 | 删除一个备份计划。 |
| DisableBackupPlan | 暂停备份计划 | 暂停一个备份计划。 |
| EnableBackupPlan | 继续备份计划 | 继续一个备份计划。 |
| UpdateBackupPlan | 更新备份计划 | 更新一个备份计划。 |
| DescribeBackupPlans | 查询符合条件的备份计划 | 获取一个或者多个符合条件的备份计划。 |
| ExecuteBackupPlan | 执行备份计划 | 执行一个备份计划。 |
备份策略
| API | 标题 | API概述 |
|---|---|---|
| CreatePolicyV2 | 创建策略 | 创建一个策略。 |
| DeletePolicyV2 | 删除策略 | 删除一个策略。 |
| UpdatePolicyV2 | 修改策略 | 修改一个策略。 |
| DescribePoliciesV2 | 查询一个或多个策略 | 查询一个或多个策略。 |
| CreatePolicyBindings | 创建策略与数据源关联 | 将一个或多个数据源绑定到某个策略。 |
| DeletePolicyBinding | 删除策略与数据源关联 | 将数据源与策略解绑，解绑后，策略将无法保护该数据源，请谨慎操作。 |
| UpdatePolicyBinding | 修改策略与数据源关联 | 修改策略与数据源的关联关系。 |
| DescribePolicyBindings | 查询绑定策略列表 | 查询策略绑定的一个或多个数据源、查询数据源绑定的一个或多个策略。 |
| ExecutePolicyV2 | 执行策略 | 为一个或所有绑定的数据源执行策略。 |
备份客户端
| API | 标题 | API概述 |
|---|---|---|
| DeleteBackupClient | 删除备份客户端 | 删除一个备份客户端。 |
| DeleteBackupClientResource | 删除备份客户端资源 | 删除备份客户端的所属资源。 |
| UpdateClientSettings | 更新客户端配置 | 更新一个备份客户端的配置。 |
| DescribeBackupClients | 获取备份客户端信息 | 获取一个或者多个符合条件的备份客户端信息。 |
| InstallBackupClients | 安装备份客户端 | 为一台或者多台ECS实例安装备份客户端。 |
| UninstallBackupClients | 卸载备份客户端 | 为一台或者多台ECS实例卸载备份客户端。 |
| UpgradeBackupClients | 升级备份客户端 | 为一台或者多台ECS实例升级备份客户端。 |
备份快照
| API | 标题 | API概述 |
|---|---|---|
| DeleteSnapshot | 删除备份快照 | 删除一个备份快照。 |
| DescribeOtsTableSnapshots | 查询表格存储备份详情 | 查询表格存储备份详情。 |
| DescribeRecoverableOtsInstances | 查询可恢复表格存储实例的数据表 | 查询可恢复表格存储实例的数据表。 |
| SearchHistoricalSnapshots | 获取备份快照 | 获取一个或者多个符合条件的历史备份快照。 |
| DescribeUdmSnapshots | 查询整机备份快照 | 查询整机备份快照。 |
恢复任务
| API | 标题 | API概述 |
|---|---|---|
| CreateRestoreJob | 创建恢复任务 | 创建一个恢复任务。 |
| CancelRestoreJob | 取消恢复任务 | 取消一个恢复任务。 |
| DescribeRestoreJobs2 | 查询恢复任务 | 查询一个或者多个符合条件的恢复任务。 |
备份任务
| API | 标题 | API概述 |
|---|---|---|
| CancelBackupJob | 取消备份任务 | 取消一个备份任务。 |
| CreateBackupJob | 创建备份任务 | 创建一个手动备份任务。 |
| DescribeBackupJobs2 | 查询备份任务 | 查询一个或者多个符合条件的备份任务。 |
SAP HANA备份
| API | 标题 | API概述 |
|---|---|---|
| CreateHanaBackupPlan | 创建SAP HANA备份计划 | 创建一个SAP Hana备份计划。 |
| CreateHanaInstance | 注册SAP HANA实例 | 注册SAP HANA实例。 |
| CreateClients | 安装客户端 | 在指定实例上安装一个或多个HBR备份客户端。 |
| DeleteClient | 删除客户端 | |
| CreateHanaRestore | 创建SAP HANA恢复任务 | 创建SAP HANA数据库恢复任务。 |
| DeleteHanaBackupPlan | 删除SAP HANA备份计划 | 删除一个SAP HANA备份计划。 |
| DeleteHanaInstance | 删除SAP HANA实例 | 删除SAP HANA实例。 |
| UninstallClient | 卸载客户端 | 调用UninstallClient接口卸载HBR备份客户端。 |
| UpdateHanaBackupPlan | 更新SAP HANA备份计划 | 更新SAP HANA备份计划。 |
| EnableHanaBackupPlan | 启动SAP HANA备份计划 | 启动指定的SAP HANA备份计划。 |
| DisableHanaBackupPlan | 暂停SAP HANA备份计划 | 暂停指定的SAP HANA备份计划。 |
| UpdateHanaInstance | 更新SAP HANA实例 | 更新SAP HANA实例。 |
| UpgradeClient | 升级客户端版本 | 升级HBR备份客户端。 |
| StartHanaDatabaseAsync | 启动SAP HANA数据库 | 启动数据库。 |
| StopHanaDatabaseAsync | 停止SAP HANA数据库 | 停止SAP HANA数据库。 |
| UpdateHanaRetentionSetting | 更新SAP HANA数据库备份保留时间 | 更新SAP HANA数据库的备份保留时间。 |
| UpdateHanaBackupSetting | 更新SAP HANA数据库备份参数 | 更新SAP HANA数据库备份参数。 |
| DescribeHanaBackupPlans | 查询符合条件的SAP HANA备份计划 | 获取一个或者多个符合条件的SAP HANA备份计划。 |
| DescribeHanaInstances | 查询符合条件的SAP HANA实例 | 查询一个或多个符合条件的SAP HANA实例。 |
| DescribeClients | 查询客户端信息 | 获取一个或多个符合条件的备份客户端。 |
| DescribeHanaDatabases | 查询符合条件的SAP HANA数据库 | 查询SAP HANA数据库信息。 |
| DescribeHanaRetentionSetting | 查询符合条件的SAP HANA数据库备份保留时间 | 查询数据库的保留时间。 |
| DescribeHanaBackupSetting | 查询符合条件的SAP HANA数据库备份参数 | 查询SAP HANA数据库的备份参数。 |
| DescribeHanaBackupsAsync | 查询符合条件的SAP HANA备份 | 查询一个或多个符合条件的SAP HANA备份。 |
| DescribeHanaRestores | 查询符合条件的SAP HANA恢复任务 | 查询符合条件的SAP HANA恢复任务。 |
ECS备份基础版
| API | 标题 | API概述 |
|---|---|---|
| DeleteAirEcsInstance | ECS备份基础版移除仅恢复ECS实例 | 从ECS备份基础版移除仅恢复ECS。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| OpenHbrService | 开通云备份服务 | 开通云备份服务。 |
| AddContainerCluster | 注册容器集群 | 注册一个容器集群。 |
| UpdateContainerCluster | 更新容器集群信息 | 更新容器集群信息，包括容器集群名称、网络类型等。 |
| DescribeRegions | 查询可用地域 | 查询可用地域。 |
| DescribeTask | 查询异步任务 | 查询一个异步任务。 |
| DescribeVaultReplicationRegions | 查询备份仓库异地复制可选的地域 | 查询备份仓库异地复制可选的地域。 |
| DescribeContainerCluster | 查询容器集群 | 查询符合条件的一个或多个容器集群。 |
| DetachNasFileSystem | 删除内部挂载点 | 删除一个由云备份服务创建的内部挂载点。 |
| GenerateRamPolicy | 生成RAM策略 | 生成RAM策略。 |
| ChangeResourceGroup | 修改实例所在的资源组 | 修改实例所在的资源组。 |
| CreateTempFileUploadUrl | 生成临时文件上传链接 | 生成上传文件链接所需的参数和签名。 |
| GetTempFileDownloadLink | 获取文件的下载链接 | 获取任务报表等文件的下载链接。 |
| CheckRole | 权限检查 | 用于检查用户是否有权限访问当前资源或页面。 |
| DescribeCrossAccounts | 查询跨账号信息 | 用于跨账号备份中，查询被当前账号管理的跨账号信息。 |
| DescribeCrossAccounts | 查询跨账号信息 | 用于跨账号备份中，查询被当前账号管理的跨账号信息。 |
| DeleteUdmEcsInstance | 取消保护ECS整机备份实例 | 取消保护ECS整机备份实例。 |
| DeleteUdmDisk | 取消保护云盘 | 取消保护云盘。 |