云備份提供可視化操作控制臺,還提供OpenAPI在線調試、阿里云SDK、Terraform、資源編排ROS等調用方式。為提升您使用云備份的開發效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓開發者快速高效的學習和使用云產品OpenAPI,阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產品大版本的API列表,例如云備份目前支持2017-09-08
版本的API列表,2017-09-08
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2017-09-08
之后就未更新。
版本號 | 說明 |
推薦使用 |
在線調試
云備份在OpenAPI門戶提供API調試等功能。在調用前,您需要了解云備份提供的版本、接入點說明、集成方式等信息。
調試入口
調試API入口為:https://next.api.aliyun.com/api/hbr/2017-09-08/CreateVault?sdkStyle=old
接入點說明
根據相關資源所在地域,選擇對應的服務接入點地址,以獲得最低延遲。例如華北3(張家口)的云備份公網接入地址為hbr.cn-zhangjiakou.aliyuncs.com
,VPC接入地址為hbr-vpc.cn-zhangjiakou.aliyuncs.com
。
公網接入地址在全球都可訪問。
VPC接入地址只有在阿里云對應的地域內,且是VPC網絡類型才可訪問。VPC地址的優勢:
高安全性:VPC服務地址只能在VPC內部訪問,提供更高的安全性和隱私性。
更快的響應速度:由于VPC服務地址在VPC內部網絡中運行,其響應速度通常比公網服務更快,且可以避免公網延遲和帶寬限制等問題。
更低的成本:VPC服務地址可以使用內部網絡通信。
更多信息,請參見服務接入點。
用戶身份
您阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作云備份資源的權限。具體操作,請參見創建RAM用戶進行云備份操作。
用戶身份 | 支持情況 |
支持 | |
RAM 用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI調用方式,推薦您選擇使用SDK。
集成方式總覽
調用方式 | 支持情況 |
阿里云 SDK(推薦) | 支持 |
不支持 | |
支持 | |
不支持 | |
支持 |
阿里云 SDK
阿里云CLI
阿里云命令行工具可以幫您在使用命令行終端時,使用
aliyun
命令與阿里云服務進行交互,管理云服務資源。有關阿里云CLI的更多詳細信息,請參見什么是阿里云CLI。暫不支持使用阿里云CLI調用云備份。
Terraform
Terraform 是一種開源工具,用于安全高效地預覽,配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似,通過將模板轉化為內部數據后完成 OpenAPI 調用。更多詳情,請參見什么是 Terraform。
支持Terraform編排和使用云備份,支持部分普通資源和數據資源清單,請參見云備份Terraform資源和數據源。
快速使用Terraform編排云備份,請參見Terraform集成示例。
資源編排ROS
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS 實例、OSS、NAS)、資源間的依賴關系等。ROS 的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。更多詳情,請參見什么是資源編排服務。
支持使用資源編排服務ROS調用云備份。編排的部分資源包括普通資源(備份客戶端、恢復任務、備份計劃、備份倉庫等)和數據資源(例如備份庫)。
普通資源:
ALIYUN::HBR::BackupClients:為ECS實例安裝備份客戶端
ALIYUN::HBR::RestoreJob:創建恢復任務
ALIYUN::HBR::DbAgent安裝數據庫備份客戶端
ALIYUN::HBR::DbPlan:創建備份計劃
ALIYUN::HBR::DbVault:創建鏡像備份倉庫
ALIYUN::HBR::Vault:創建一個備份倉庫
數據資源:
DATASOURCE::HBR::Vaults:查詢備份倉庫基礎信息
快速使用資源編排ROS編排云備份,請參見資源編排ROS集成示例。
自定義封裝API調用
原生HTTP調用需要您自己實現簽名算法,并構建自定義請求,發起HTTP調用。有關簽名機制的更多詳細信息,請參見云備份API參考指南和V3版本請求體&簽名機制。
注意事項
如果調用云備份API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。更多信息,請參見公共錯誤碼。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。
常見問題
如果您想了解云備份產品,請參見什么是云備份。
云備份可以為阿里云ECS整機、ECS數據庫(MySQL/SQL Server/Oracle)、文件系統、NAS、OSS以及自建機房內的文件、數據庫、虛擬機、大規模NAS等提供備份、容災保護的混合云產品。了解更多產品支持的特性,請參見云備份支持的功能特性清單。
除了Java SDK,還支持C#、Go、Python、Node.js/TypeScript、PHP、C++等,更多信息,請參見SDK參考。