API標準及多語言預置SDK
本產品（hbr/2017-09-08）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
備份倉庫
|
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概述 |
| DescribeOtsTableSnapshots | 查詢Table Store備份詳情 | 查詢Table Store備份詳情。 |
| DescribeRecoverableOtsInstances | 查詢可恢複Table Store執行個體的資料表 | 查詢可恢複Table Store執行個體的資料表。 |
| SearchHistoricalSnapshots | 擷取備份快照 | 擷取一個或者多個合格歷史備份快照。 |
| DescribeUdmSnapshots | 查詢整機備份快照 | 查詢整機備份快照。 |
| 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 HANADatabase Backup保留時間 | 更新SAP HANA資料庫的備份保留時間。 |
| UpdateHanaBackupSetting | 更新SAP HANADatabase Backup參數 | 更新SAP HANADatabase Backup參數。 |
| DescribeHanaBackupPlans | 查詢合格SAP HANA備份計劃 | 擷取一個或者多個合格 SAP HANA 備份計劃。 |
| DescribeHanaInstances | 查詢合格SAP HANA執行個體 | 查詢一個或多個合格SAP HANA執行個體。 |
| DescribeClients | 查詢用戶端資訊 | 擷取一個或多個合格備份用戶端。 |
| DescribeHanaDatabases | 查詢合格SAP HANA資料庫 | 查詢SAP HANA資料庫資訊。 |
| DescribeHanaRetentionSetting | 查詢合格SAP HANADatabase Backup保留時間 | 查詢資料庫的保留時間。 |
| DescribeHanaBackupSetting | 查詢合格SAP HANADatabase Backup參數 | 查詢SAP HANA資料庫的備份參數。 |
| DescribeHanaBackupsAsync | 查詢合格SAP HANA備份 | 查詢一個或多個合格SAP HANA備份。 |
| DescribeHanaRestores | 查詢合格SAP HANA恢複任務 | 查詢合格SAP HANA恢複任務。 |
ECS備份基礎版
|
API |
標題 |
API概述 |
| DeleteAirEcsInstance | ECS備份基礎版移除僅恢複ECS執行個體 | 從ECS備份基礎版移除僅恢複ECS。 |
容器備份
|
API |
標題 |
API概述 |
| DescribeContainerResource | 查詢容器叢集資源 | 查詢容器叢集資源清單。 |
| DeleteContainerCluster | 登出容器叢集 | 登出雲備份-容器備份中容器叢集記錄。登出後，該容器叢集下的備份將無法恢複。 |
| DescribeContainerCluster | 查詢容器叢集 | 查詢合格一個或多個容器叢集。 |
| UpdateContainerCluster | 更新容器叢集資訊 | 更新容器叢集資訊，包括容器叢集名稱、網路類型等。 |
| AddContainerCluster | 註冊容器叢集 | 註冊一個容器叢集。 |
其他
|
API |
標題 |
API概述 |
| OpenHbrService | 開通雲備份服務 | 開通雲備份服務。 |
| DescribeTask | 查詢非同步任務 | 查詢一個非同步任務。 |
| DescribeVaultReplicationRegions | 查詢備份倉庫異地複寫可選的地區 | 查詢備份倉庫異地複寫可選的地區。 |
| DetachNasFileSystem | 刪除內部掛載點 | 刪除一個由雲備份服務建立的內部掛載點。 |
| GenerateRamPolicy | 產生RAM策略 | 產生RAM策略。 |
| CreateTempFileUploadUrl | 產生臨時檔案上傳連結 | 產生上傳檔案連結所需的參數和簽名。 |
| GetTempFileDownloadLink | 擷取檔案的下載連結 | 擷取任務報表等檔案的下載連結。 |
| DescribeCrossAccounts | 查詢跨帳號資訊 | 查詢跨帳號納管關係。 |
| DeleteUdmEcsInstance | 取消保護ECS整機備份執行個體 | 取消保護ECS整機備份執行個體。 |
| DeleteUdmDisk | 取消保護雲端硬碟 | 取消保護雲端硬碟。 |
| AddCrossAccount | 添加跨帳號納管關係 | 添加跨帳號納管關係。 |
| AddDataSource | 建立資料來源 | 建立資料來源。 |
| BrowseFiles | 瀏覽備份檔案列表 | 瀏覽備份檔案列表 |
| CreateVaultReplication | 配置備份庫複製 | 配置備份庫複製。 |
| DeleteCrossAccount | 刪除跨帳號納管關係 | 刪除跨帳號納管關係。 |
| DeleteVaultReplication | 停止備份庫複製 | 停止備份庫複製。 |
| DescribeDataSources | 查詢資料來源列表 | 查詢資料來源列表。 |
| GetBasicStatistics | 查詢備份基礎版統計資料 | 擷取備份基礎版統計資料 |
| ListProtectedResources | 查詢已保護的資源清單 | 查詢已保護的資源清單 |
| RemoveDataSource | 刪除資料來源 | 刪除資料來源。 |
| GetBasicStatistics | 查詢備份基礎版統計資料 | 擷取備份基礎版統計資料 |
| ListProtectedResources | 查詢已保護的資源清單 | 查詢已保護的資源清單 |
| RemoveDataSource | 刪除資料來源 | 刪除資料來源。 |
| UpdateDataSource | 更新資料來源配置 | 更新資料來源配置。 |