本產(chǎn)品（
云備份 Cloud Backup/2017-09-08）的OpenAPI采用RPC簽名風(fēng)格，簽名細節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節(jié)非常復(fù)雜，需花費 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節(jié)請參見獲取AccessKey。
備份倉庫
| API | 標題 | API概述 |
|---|---|---|
| CreateVault | 創(chuàng)建備份倉庫 | 創(chuàng)建一個備份倉庫。 |
| CreateReplicationVault | 創(chuàng)建鏡像備份倉庫 | 創(chuàng)建一個鏡像備份倉庫。 |
| DeleteVault | 刪除備份倉庫 | 刪除一個備份倉庫。 |
| UpdateVault | 更新備份倉庫的配置信息 | 更新備份倉庫的配置信息。 |
| DescribeVaults | 查詢備份倉庫信息 | 獲取一個或者多個符合條件的備份倉庫信息。 |
備份計劃
| API | 標題 | API概述 |
|---|---|---|
| CreateBackupPlan | 創(chuàng)建備份計劃 | 創(chuàng)建一個備份計劃。 |
| DeleteBackupPlan | 刪除備份計劃 | 刪除一個備份計劃。 |
| DisableBackupPlan | 暫停備份計劃 | 暫停一個備份計劃。 |
| EnableBackupPlan | 繼續(xù)備份計劃 | 繼續(xù)一個備份計劃。 |
| UpdateBackupPlan | 更新備份計劃 | 更新一個備份計劃。 |
| DescribeBackupPlans | 查詢符合條件的備份計劃 | 獲取一個或者多個符合條件的備份計劃。 |
| ExecuteBackupPlan | 執(zhí)行備份計劃 | 執(zhí)行一個備份計劃。 |
備份策略
| API | 標題 | API概述 |
|---|---|---|
| CreatePolicyV2 | 創(chuàng)建策略 | 創(chuàng)建一個策略。 |
| DeletePolicyV2 | 刪除策略 | 刪除一個策略。 |
| UpdatePolicyV2 | 修改策略 | 修改一個策略。 |
| DescribePoliciesV2 | 查詢一個或多個策略 | 查詢一個或多個策略。 |
| CreatePolicyBindings | 創(chuàng)建策略與數(shù)據(jù)源關(guān)聯(lián) | 將一個或多個數(shù)據(jù)源綁定到某個策略。 |
| DeletePolicyBinding | 刪除策略與數(shù)據(jù)源關(guān)聯(lián) | 將數(shù)據(jù)源與策略解綁，解綁后，策略將無法保護該數(shù)據(jù)源，請謹慎操作。 |
| UpdatePolicyBinding | 修改策略與數(shù)據(jù)源關(guān)聯(lián) | 修改策略與數(shù)據(jù)源的關(guān)聯(lián)關(guān)系。 |
| DescribePolicyBindings | 查詢綁定策略列表 | 查詢策略綁定的一個或多個數(shù)據(jù)源、查詢數(shù)據(jù)源綁定的一個或多個策略。 |
| ExecutePolicyV2 | 執(zhí)行策略 | 為一個或所有綁定的數(shù)據(jù)源執(zhí)行策略。 |
備份客戶端
| API | 標題 | API概述 |
|---|---|---|
| DeleteBackupClient | 刪除備份客戶端 | 刪除一個備份客戶端。 |
| DeleteBackupClientResource | 刪除備份客戶端資源 | 刪除備份客戶端的所屬資源。 |
| UpdateClientSettings | 更新客戶端配置 | 更新一個備份客戶端的配置。 |
| DescribeBackupClients | 獲取備份客戶端信息 | 獲取一個或者多個符合條件的備份客戶端信息。 |
| InstallBackupClients | 安裝備份客戶端 | 為一臺或者多臺ECS實例安裝備份客戶端。 |
| UninstallBackupClients | 卸載備份客戶端 | 為一臺或者多臺ECS實例卸載備份客戶端。 |
| UpgradeBackupClients | 升級備份客戶端 | 為一臺或者多臺ECS實例升級備份客戶端。 |
備份快照
| API | 標題 | API概述 |
|---|---|---|
| DeleteSnapshot | 刪除備份快照 | 刪除一個備份快照。 |
| DescribeOtsTableSnapshots | 查詢表格存儲備份詳情 | 查詢表格存儲備份詳情。 |
| DescribeRecoverableOtsInstances | 查詢可恢復(fù)表格存儲實例的數(shù)據(jù)表 | 查詢可恢復(fù)表格存儲實例的數(shù)據(jù)表。 |
| SearchHistoricalSnapshots | 獲取備份快照 | 獲取一個或者多個符合條件的歷史備份快照。 |
| DescribeUdmSnapshots | 查詢整機備份快照 | 查詢整機備份快照。 |
恢復(fù)任務(wù)
| API | 標題 | API概述 |
|---|---|---|
| CreateRestoreJob | 創(chuàng)建恢復(fù)任務(wù) | 創(chuàng)建一個恢復(fù)任務(wù)。 |
| CancelRestoreJob | 取消恢復(fù)任務(wù) | 取消一個恢復(fù)任務(wù)。 |
| DescribeRestoreJobs2 | 查詢恢復(fù)任務(wù) | 查詢一個或者多個符合條件的恢復(fù)任務(wù)。 |
備份任務(wù)
| API | 標題 | API概述 |
|---|---|---|
| CreateBackupJob | 創(chuàng)建備份任務(wù) | 創(chuàng)建一個手動備份任務(wù)。 |
| CancelBackupJob | 取消備份任務(wù) | 取消一個備份任務(wù)。 |
| DescribeBackupJobs2 | 查詢備份任務(wù) | 查詢一個或者多個符合條件的備份任務(wù)。 |
SAP HANA備份
| API | 標題 | API概述 |
|---|---|---|
| CreateHanaBackupPlan | 創(chuàng)建SAP HANA備份計劃 | 創(chuàng)建一個SAP Hana備份計劃。 |
| CreateHanaInstance | 注冊SAP HANA實例 | 注冊SAP HANA實例。 |
| CreateClients | 安裝客戶端 | 在指定實例上安裝一個或多個HBR備份客戶端。 |
| DeleteClient | 刪除客戶端 | |
| CreateHanaRestore | 創(chuàng)建SAP HANA恢復(fù)任務(wù) | 創(chuàng)建SAP HANA數(shù)據(jù)庫恢復(fù)任務(wù)。 |
| DeleteHanaBackupPlan | 刪除SAP HANA備份計劃 | 刪除一個SAP HANA備份計劃。 |
| DeleteHanaInstance | 刪除SAP HANA實例 | 刪除SAP HANA實例。 |
| UninstallClient | 卸載客戶端 | 調(diào)用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數(shù)據(jù)庫 | 啟動數(shù)據(jù)庫。 |
| StopHanaDatabaseAsync | 停止SAP HANA數(shù)據(jù)庫 | 停止SAP HANA數(shù)據(jù)庫。 |
| UpdateHanaRetentionSetting | 更新SAP HANA數(shù)據(jù)庫備份保留時間 | 更新SAP HANA數(shù)據(jù)庫的備份保留時間。 |
| UpdateHanaBackupSetting | 更新SAP HANA數(shù)據(jù)庫備份參數(shù) | 更新SAP HANA數(shù)據(jù)庫備份參數(shù)。 |
| DescribeHanaBackupPlans | 查詢符合條件的SAP HANA備份計劃 | 獲取一個或者多個符合條件的SAP HANA備份計劃。 |
| DescribeHanaInstances | 查詢符合條件的SAP HANA實例 | 查詢一個或多個符合條件的SAP HANA實例。 |
| DescribeClients | 查詢客戶端信息 | 獲取一個或多個符合條件的備份客戶端。 |
| DescribeHanaDatabases | 查詢符合條件的SAP HANA數(shù)據(jù)庫 | 查詢SAP HANA數(shù)據(jù)庫信息。 |
| DescribeHanaRetentionSetting | 查詢符合條件的SAP HANA數(shù)據(jù)庫備份保留時間 | 查詢數(shù)據(jù)庫的保留時間。 |
| DescribeHanaBackupSetting | 查詢符合條件的SAP HANA數(shù)據(jù)庫備份參數(shù) | 查詢SAP HANA數(shù)據(jù)庫的備份參數(shù)。 |
| DescribeHanaBackupsAsync | 查詢符合條件的SAP HANA備份 | 查詢一個或多個符合條件的SAP HANA備份。 |
| DescribeHanaRestores | 查詢符合條件的SAP HANA恢復(fù)任務(wù) | 查詢符合條件的SAP HANA恢復(fù)任務(wù)。 |
ECS備份基礎(chǔ)版
| API | 標題 | API概述 |
|---|---|---|
| DeleteAirEcsInstance | ECS備份基礎(chǔ)版移除僅恢復(fù)ECS實例 | 從ECS備份基礎(chǔ)版移除僅恢復(fù)ECS。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| OpenHbrService | 開通云備份服務(wù) | 開通云備份服務(wù)。 |
| AddContainerCluster | 注冊容器集群 | 注冊一個容器集群。 |
| UpdateContainerCluster | 更新容器集群信息 | 更新容器集群信息，包括容器集群名稱、網(wǎng)絡(luò)類型等。 |
| DescribeRegions | 查詢可用地域 | 查詢可用地域。 |
| DescribeTask | 查詢異步任務(wù) | 查詢一個異步任務(wù)。 |
| DescribeVaultReplicationRegions | 查詢備份倉庫異地復(fù)制可選的地域 | 查詢備份倉庫異地復(fù)制可選的地域。 |
| DescribeContainerCluster | 查詢?nèi)萜骷?/span> | 查詢符合條件的一個或多個容器集群。 |
| DetachNasFileSystem | 刪除內(nèi)部掛載點 | 刪除一個由云備份服務(wù)創(chuàng)建的內(nèi)部掛載點。 |
| GenerateRamPolicy | 生成RAM策略 | 生成RAM策略。 |
| ChangeResourceGroup | 修改實例所在的資源組 | 修改實例所在的資源組。 |
| CreateTempFileUploadUrl | 生成臨時文件上傳鏈接 | 生成上傳文件鏈接所需的參數(shù)和簽名。 |
| GetTempFileDownloadLink | 獲取文件的下載鏈接 | 獲取任務(wù)報表等文件的下載鏈接。 |
| CheckRole | 權(quán)限檢查 | 用于檢查用戶是否有權(quán)限訪問當(dāng)前資源或頁面。 |
| DescribeCrossAccounts | 查詢跨賬號信息 | 用于跨賬號備份中，查詢被當(dāng)前賬號管理的跨賬號信息。 |
| DescribeCrossAccounts | 查詢跨賬號信息 | 用于跨賬號備份中，查詢被當(dāng)前賬號管理的跨賬號信息。 |
| DeleteUdmEcsInstance | 取消保護ECS整機備份實例 | 取消保護ECS整機備份實例。 |
| DeleteUdmDisk | 取消保護云盤 | 取消保護云盤。 |