API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (hdr/2017-09-25) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Server management
|
API |
Title |
Description |
| RegisterServers | Add a protected server | Add servers to protection. |
| UnregisterServer | Log off a protected server | Removes a protected server from the backup service. |
| DescribeServer | Query protected servers | Query information about a protected server. |
| DescribeServers | Query protected servers | Queries protected servers. |
Site pair management
|
API |
Title |
Description |
| DescribeSitePairs | Query site pair information | Query site pair information. |
| DescribeSite | Query site information | Queries information about a site. |
| DeleteSitePair | Delete a site pair | Deletes a site pair. |
| CreateSitePair | Create a site pair | Creates a disaster recovery site pair. |
| DescribeSitePair | Query site pair information | Query information about a site pair. |
Failover
|
API |
Title |
Description |
| EnableReplication | Start replication | Enables replication. |
| DisableReplication | Stop copy | Stop replication. |
| TestFailover | Disaster recovery drills | Performs a disaster recovery drill. |
| TestCleanup | Clean up the disaster recovery drills environment | Cleans up the disaster recovery drills environment. |
| DescribeRecoveryPoints | Query active recovery points | List the available recovery points. |
| ChangeRecoveryPoint | Change the recovery point | Changes a recovery point. |
| CommitFailover | Confirm failover | Confirm the failover. |
| ForcedFailover | Failover | Performs a forced failover. |
Failback
|
API |
Title |
Description |
| TriggerReversedRegister | Reverse Registration | Reverse register the instance that completed failover. This operation registers the instance from the destination site back to the source site to prepare the system for reverse replication and failback. |
| DescribeInfrastructures | Query site infrastructure | Queries infrastructure information for a site. Hybrid Disaster Recovery supports disaster recovery across multiple scenarios, such as IDC-to-cloud, cross-region, and cross-zone disaster recovery. Infrastructure varies by scenario. For example, in IDC-to-cloud disaster recovery, the source site may use physical servers or VMware vCenter. In cross-region and cross-zone disaster recovery, Alibaba Cloud serves as the primary infrastructure. |
| ReversedEnableReplication | Start reverse replication | Start reverse replication. |
| ReversedDisableReplication | Stop reverse replication | Stops reverse replication. |
| Failback | Fault recovery | Failback. |
Recovery plan
|
API |
Title |
Description |
| CreateRecoveryPlan | Create a recovery plan | Creates a recovery plan. |
| DeleteRecoveryPlan | Delete Recovery Plan | Delete a recovery plan by its ID. |
| DescribeRecoveryPlan | Query the details of a recovery plan | Query the details of a recovery plan. |
| DescribeRecoveryPlans | Query the recovery plan list | Lists recovery plans for a site pair. |
| UpdateRecoveryPlan | Edit Recovery Plan | Modifies the content of a recovery plan. |
Others
|
API |
Title |
Description |
| DescribeAvailableInstanceTypes | Query Available Instance Types | Queries the available instance types for scenarios such as disaster recovery drills, failovers, and failbacks. |
| DescribeTask | Query Job | Queries the details of a task. |
| DescribeTasks | Query Job List | Lists tasks. |
Others
|
API |
Title |
Description |
| DescribeSitePairStatistics | Query site pair statistics information | Query performance statistics for a site. |
| DescribeSummary | Query overview information | Queries overview information. |