文档

API概览

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

备份仓库

API标题API概述
CreateVault创建备份仓库调用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概述
CreateBackupJob创建备份任务创建一个手动备份任务。
CancelBackupJob取消备份任务取消一个备份任务。
DescribeBackupJobs2查询备份任务查询一个或者多个符合条件的备份任务。

SAP HANA备份

API标题API概述
CreateHanaBackupPlan创建SAP HANA备份计划创建一个SAP Hana备份计划。
CreateHanaInstance注册SAP HANA实例注册SAP HANA实例。
CreateClients安装客户端调用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恢复任务。

其他

API标题API概述
OpenHbrService开通云备份服务开通云备份服务。
AddContainerCluster注册容器集群注册一个容器集群。
UpdateContainerCluster更新容器集群信息更新容器集群信息,包括容器集群名称、网络类型等。
DescribeRegions查询可用地域查询可用地域。
DescribeTask查询异步任务查询一个异步任务。
DescribeVaultReplicationRegions查询备份仓库异地复制可选的地域查询备份仓库异地复制可选的地域。
DescribeContainerCluster查询容器集群查询符合条件的一个或多个容器集群。
DetachNasFileSystem删除内部挂载点删除一个由云备份服务创建的内部挂载点。
GenerateRamPolicy生成RAM策略生成RAM策略。
ChangeResourceGroup修改实例所在的资源组修改实例所在的资源组。
CreateTempFileUploadUrl生成临时文件上传链接生成上传文件链接所需的参数和签名。
GetTempFileDownloadLink获取文件的下载链接获取任务报表等文件的下载链接。
CheckRole权限检查用于检查用户是否有权限访问当前资源或页面。
DescribeCrossAccounts查询跨账号信息用于跨账号备份中,查询被当前账号管理的跨账号信息。
DescribeCrossAccounts查询跨账号信息用于跨账号备份中,查询被当前账号管理的跨账号信息。
DeleteUdmEcsInstance取消保护ECS整机备份实例取消保护ECS整机备份实例。
DeleteUdmDisk取消保护云盘