Integration overview
Hybrid Disaster Recovery provides a visual console and offers programmatic access through OpenAPI for API debugging and Alibaba Cloud SDK calls. To improve your development efficiency with Hybrid Disaster Recovery, choose the integration method that best suits your requirements.
OpenAPI
To help developers learn and use cloud product APIs quickly and efficiently, Alibaba Cloud provides the OpenAPI portal. This platform integrates intelligent API search, documentation, API debugging, SDK downloads, code samples, error diagnostics, and call statistics. In the OpenAPI portal, you can call the API operations of various Alibaba Cloud services and view the requests and responses. The portal also automatically generates SDK code samples to help you quickly start using Alibaba Cloud products. For more information, see What is OpenAPI?.
Versions
Alibaba Cloud OpenAPI uses version numbers to manage API sets for major product releases. For example, Hybrid Disaster Recovery currently supports API version 2017-09-25. The string 2017-09-25 is a version identifier, not a date. It provides access to the latest public APIs, which may have been updated after the version was initially released. This means the APIs are not frozen as of 2017-09-25.
|
Version number |
Description |
|
Recommended |
API debugging
The OpenAPI portal provides features such as API debugging for Hybrid Disaster Recovery. Before you call an API, you must be familiar with the available versions, service endpoints, and integration methods for Hybrid Disaster Recovery.
Debugging entry point
The entry point for API debugging is: https://next.api.aliyun.com/api/hdr/2017-09-25/RegisterServers
Service endpoints
To achieve the lowest latency, choose the service endpoint that is in the same region as your resources. As an efficient disaster recovery solution, Hybrid Disaster Recovery provides centralized management and monitoring of the disaster recovery process. To ensure high availability of the console, it is deployed with active-standby public network endpoints for seamless failover, enhancing system stability and reliability. The public network service endpoints are globally accessible. For more information, see Service endpoints.
User identity
After you sign in to the OpenAPI portal with your Alibaba Cloud account, API calls use this account by default. An Alibaba Cloud account has full access to all APIs, which poses a high security risk. We strongly recommend that you create and use a RAM user for API access and daily operations. Before calling APIs, grant the RAM user the permissions required by your business. The RAM user must have the permissions to operate Cloud Backup resources.
|
User identity |
Supported |
|
Yes |
|
|
RAM user (Recommended) |
Yes |
|
RAM role (Recommended) |
Yes |
More information
Integration methods
Using an SDK is the recommended method for calling APIs. It provides the easiest integration and the best support.
Overview
|
Method |
Supported |
|
Alibaba Cloud SDK (Recommended) |
Yes |
|
Yes |
-
Alibaba Cloud SDK
-
Alibaba Cloud provides SDKs for multiple programming languages, including Java, TypeScript, PHP, Python, C#, and Swift. To call an API, integrate the appropriate SDK and use its exposed methods. The SDKs handle low-level details such as signing logic, timeout settings, and retry mechanisms. They also parse the response into structured objects, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
-
You can call Hybrid Disaster Recovery APIs by using Alibaba Cloud SDKs. For a list of supported languages and instructions on how to install dependencies, see Hybrid Disaster Recovery SDK.
-
-
Custom API calls
If you make direct HTTP calls, you must implement the signing algorithm, build the custom request, and manage the HTTP transaction yourself. For more information about the signing mechanism, see Hybrid Disaster Recovery API Reference and V3 Request Body and Signature Mechanism.
Usage notes
If a call to a Hybrid Disaster Recovery API returns an error, check the request parameters and their values based on the returned error code. For more information, see Common error codes.
You can also use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnosis by providing the Request ID from the API response or the error message from the SDK.
FAQ
-
Hybrid Disaster Recovery provides disaster recovery for ECS instances by using continuous data replication (CDR) or asynchronous replication of cloud disks. To learn more about the service, see What is Hybrid Disaster Recovery?.
-
In addition to the Java SDK, SDKs are also available for C#, Python, TypeScript, PHP, and Swift. For more information, see SDK Reference.