# Alibaba Cloud Hybrid Disaster Recovery API

> Alibaba Cloud Hybrid Disaster Recovery API on Apizie: 33 endpoints (Changes a recovery point, Confirm the failover, Creates a recovery plan, Creates a disaster recovery site pair, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-hdr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-hdr`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/hdr
- Page: https://apizie.tech/api/cloud/aliyun-hdr
- OpenAPI: https://apizie.tech/api/cloud/aliyun-hdr/openapi.json

Alibaba Cloud OpenAPI for Hybrid Disaster Recovery (hdr, version 2017-09-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Changes a recovery point
`POST https://apizie.tech/v1/cloud:aliyun-hdr/change-recovery-point` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | ID of the protected server |
| RecoveryInstanceName | string | no | Name of the recovered instance |
| RecoveryCpu | integer | no | Number of vCPUs for the recovered instance |
| RecoveryMemory | integer | no | Memory size (bytes) for the recovered instance |
| RecoveryInstanceType | string | no | Instance type of the recovered instance |
| RecoveryUseSsd | string | no | Whether the recovered instance uses SSD storage |
| RecoveryUseEssd | string | no | Whether the recovered instance uses ESSD storage |
| RecoveryNetwork | string | no | VSwitch ID for the recovered instance |
| RecoveryReserveIp | string | no | Whether the recovered instance retains the source server's IP address |
| RecoveryUseDhcp | string | no | Whether the recovered instance uses DHCP to assign an IP address |
| RecoveryIpAddress | string | no | Manually specified IP address for the recovered instance |
| RecoveryPostScriptType | string | no | Type of script to run after the recovered instance starts |
| RecoveryPostScriptContent | string | no | Content of the script to run after the recovered instance starts |
| RecoveryPointId | string | no | ID of the recovery point |
| RecoveryPointTime | integer | no | Timestamp of the recovery point |
| EipAddressId | string | no | Elastic Network Interface (ENI) ID attached to the recovered instance |
| RecoveryEssdPerformanceLevel | string | no | Performance level (PL) of the ESSD disk. Valid PL levels depend on the minimum disk size |

### Confirm the failover
`POST https://apizie.tech/v1/cloud:aliyun-hdr/commit-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | The ID of the protected server |

### Creates a recovery plan
`POST https://apizie.tech/v1/cloud:aliyun-hdr/create-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | The site pair ID |
| Name | string | no | The recovery plan name |
| Direction | string | no | The direction of the recovery plan. Supports forward |
| Content | string | no | The recovery plan details |

### Creates a disaster recovery site pair
`POST https://apizie.tech/v1/cloud:aliyun-hdr/create-site-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairType | string | no | The type of the site pair |
| PrimarySiteName | string | no | The name of the primary site |
| PrimarySiteType | string | no | The type of the primary site |
| PrimarySiteRegionId | string | no | The region ID of the primary site |
| PrimarySiteVpcId | string | no | The virtual private cloud (VPC) ID of the primary site |
| PrimarySiteZoneId | string | no | The zone ID of the primary site. This parameter is valid only when the site pair type is cross-zone disaster recovery |
| SecondarySiteName | string | no | The name of the secondary site |
| SecondarySiteType | string | no | The type of the secondary site |
| SecondarySiteRegionId | string | no | The region ID of the secondary site |
| SecondarySiteVpcId | string | no | The VPC ID of the secondary site |
| SecondarySiteZoneId | string | no | The zone ID of the secondary site. This parameter is valid only when the site pair type is cross-zone disaster recovery |

### Delete a recovery plan by its ID
`POST https://apizie.tech/v1/cloud:aliyun-hdr/delete-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| RecoveryPlanId | string | no | The ID of the recovery plan |

### Deletes a site pair
`POST https://apizie.tech/v1/cloud:aliyun-hdr/delete-site-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | yes | ID of the site pair |

### Queries the available instance types for scenarios such as disaster recovery drills, failovers, and failbacks
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-available-instance-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| Region | string | yes | The region ID |
| ZoneId | string | yes | The zone ID |
| DiskType | string | yes | The disk type |
| ChargeType | string | no | The billing method |
| Network | string | no | The network type |
| IoOptimized | string | no | Specifies whether the instance is I/O optimized |
| SortBy | string | no | The field to sort by |
| Order | string | no | The sort order |
| Filter | string | no | The filter expression for the query. Separate multiple expressions with semicolons (;). An expression consists of a key, an operator, and… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| UserClient | string | no | Specifies whether to use your user role to query for available instance types. By default, the query is performed using the Hybrid… |

### Queries infrastructure information for a site. Hybrid Disaster Recovery supports disaster recovery across…
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-infrastructures` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SiteId | string | no | Site ID |
| PageNumber | integer | no | Page number of the current page |
| PageSize | integer | no | Number of entries per page |

### Query the details of a recovery plan
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| RecoveryPlanId | string | no | The ID of the recovery plan |

### Lists recovery plans for a site pair
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-recovery-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | ID of the site pair |
| PageNumber | integer | no | Page number for the paged query. Default value: 1 |
| PageSize | integer | no | Number of entries per page for the paged query. Default value: 10 |

### List the available recovery points
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-recovery-points` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | ID of the protected server |
| StartTime | integer | no | Start time for the query. List recovery points created on or after this time |

### Query information about a protected server
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | ID of the protected server |

### Queries protected servers
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | Site pair ID |
| ServerIds | string | no | List of protected server IDs |
| PageNumber | integer | no | Page number |
| PageSize | integer | no | Number of entries per page |

### Queries information about a site
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-site` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SiteId | string | yes | The ID of the site |

### Query information about a site pair
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-site-pair` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | yes | ID of the site pair |

### Query performance statistics for a site
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-site-pair-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | ID of the site pair |

### Query site pair information
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-site-pairs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairType | string | no | Site pair type |
| PageNumber | integer | no | Current page number. |
| PageSize | integer | no | Number of entries per page for paged query. Default value is 10. |

### Queries overview information
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |

### Queries the details of a task
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| TaskId | string | yes | The task ID |

### Lists tasks
`POST https://apizie.tech/v1/cloud:aliyun-hdr/describe-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | ID of the site pair |
| PageNumber | integer | no | Page number of the paged query |
| PageSize | integer | no | Number of entries per page |
| SortBy | string | no | Sort by creation time or update time |

### Stop replication
`POST https://apizie.tech/v1/cloud:aliyun-hdr/disable-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | Protected server ID |

### Enables replication
`POST https://apizie.tech/v1/cloud:aliyun-hdr/enable-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | The ID of the protected server |
| ReplicationUseSsd | string | no | Specifies whether the replication instance uses standard SSDs |
| ReplicationUseEssd | string | no | Specifies whether the replication instance uses ESSDs |
| ReplicationNetwork | string | no | The ID of the VSwitch for the replication network |
| RecoveryNetwork | string | no | The ID of the VSwitch for the recovery network |
| CrashConsistentPointPolicy | string | no | The recovery point policy |

### Failback
`POST https://apizie.tech/v1/cloud:aliyun-hdr/failback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | Protected server ID |
| RecoveryInfrastructureId | string | no | Recovery site infrastructure ID |
| RecoveryInstanceName | string | no | Instance name for disaster recovery |
| RecoveryCpu | integer | no | Number of CPU cores for the disaster recovery instance |
| RecoveryMemory | integer | no | Memory size for the disaster recovery instance, in MB |
| RecoveryInstanceType | string | no | Instance type for disaster recovery. If not specified, the system automatically selects an available instance type based on the number of… |
| RecoveryNetwork | string | no | VSwitch ID of the failback instance |
| RecoveryReserveIp | string | no | Retain the original IP address for the failback instance |
| RecoveryUseDhcp | string | no | Use DHCP to assign an IP address to the failback instance |
| RecoveryIpAddress | string | no | Manually set the IP address for the failback instance |
| RecoveryPostScriptType | string | no | Script type to run after the failback instance starts |
| RecoveryPostScriptContent | string | no | Script content to run after the failback instance starts |
| RecoveryPointId | string | no | Recovery point ID |

### Performs a forced failover
`POST https://apizie.tech/v1/cloud:aliyun-hdr/forced-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | The ID of the protected server |
| RecoveryInstanceName | string | no | The name of the failover instance |
| RecoveryCpu | integer | no | The number of vCPUs for the failover instance |
| RecoveryMemory | integer | no | The memory size of the failover instance |
| RecoveryInstanceType | string | no | The instance type of the failover instance |
| RecoveryUseSsd | string | no | Indicates whether the cloud disks of the failover instance are solid-state drives (SSDs) |
| RecoveryUseEssd | string | no | Indicates whether the cloud disks of the failover instance are Enhanced SSDs (ESSDs) |
| RecoveryNetwork | string | no | The ID of the vSwitch where the failover instance is located |
| RecoveryReserveIp | string | no | Indicates whether the failover instance retains the IP address of the source server |
| RecoveryUseDhcp | string | no | Indicates whether the failover instance uses Dynamic Host Configuration Protocol (DHCP) to assign an IP address |
| RecoveryIpAddress | string | no | The IP address that is manually specified for the failover instance |
| RecoveryPostScriptType | string | no | The type of the script to execute after the failover instance starts |
| RecoveryPostScriptContent | string | no | The content of the script to execute after the failover instance starts |
| RecoveryPointId | string | no | The recovery point ID |
| RecoveryPointTime | integer | no | The time of the recovery point |
| EipAddressId | string | no | The ID of the elastic network interface (ENI) that is attached to the instance for failover |
| RecoveryEssdPerformanceLevel | string | no | The performance level (PL) of the ESSD. The supported PL is determined by the minimum cloud disk size |

### Add servers to protection
`POST https://apizie.tech/v1/cloud:aliyun-hdr/register-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| SitePairId | string | no | Site pair ID |
| ServerInstancesInfo | string | no | Server registration information |
| AgentPort | integer | no | Agent service port. Default is 9080 |

### Stops reverse replication
`POST https://apizie.tech/v1/cloud:aliyun-hdr/reversed-disable-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | ID of the protected server |

### Start reverse replication
`POST https://apizie.tech/v1/cloud:aliyun-hdr/reversed-enable-replication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | Protected server ID |
| ReplicationUseOriginalInstance | string | no | Use the source instance for reverse replication |
| ReplicationInfrastructureId | string | no | Target site infrastructure ID |
| ReplicationLocation | string | no | - |
| ReplicationComputeResource | string | no | - |
| ReplicationDatastore | string | no | - |
| ReplicationNetwork | string | no | VSwitch ID of the replication network for reverse replication |
| ReplicationUseDhcp | string | no | - |
| ReplicationIpAddress | string | no | - |
| ReplicationNetMask | string | no | - |
| ReplicationDns | string | no | - |
| ReplicationGateway | string | no | - |
| RecoveryNetwork | string | no | VSwitch ID of the recovery network for reverse replication |
| CrashConsistentPointPolicy | string | no | - |
| AppConsistentPointPolicy | string | no | - |
| ShadowInstanceType | string | no | - |

### Cleans up the disaster recovery drills environment
`POST https://apizie.tech/v1/cloud:aliyun-hdr/test-cleanup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | Protected server ID |

### Performs a disaster recovery drill
`POST https://apizie.tech/v1/cloud:aliyun-hdr/test-failover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | Protected server ID |
| RecoveryInstanceName | string | no | Instance name for the drill |
| RecoveryCpu | integer | no | Number of CPU cores for the drill instance |
| RecoveryMemory | integer | no | Memory size of the drill instance, in MB |
| RecoveryInstanceType | string | no | Instance type for the drill. If not specified, the system automatically finds an available instance type based on the specified number of… |
| RecoveryUseSsd | string | no | Whether the drill instance uses SSD cloud disks |
| RecoveryUseEssd | string | no | Whether the drill instance uses ESSD cloud disks |
| RecoveryNetwork | string | no | VSwitch ID where the drill instance resides |
| RecoveryReserveIp | string | no | Whether the drill instance retains the source machine's IP address (requires the VSwitch where the drill runs to include the corresponding… |
| RecoveryUseDhcp | string | no | Whether the drill instance uses DHCP to assign an IP address |
| RecoveryIpAddress | string | no | IP address of the drill instance |
| RecoveryPostScriptType | string | no | Script type to execute after the drill instance starts. Options: SHELL |
| RecoveryPostScriptContent | string | no | Script to execute after the drill instance starts |
| RecoveryPointId | string | no | Recovery point ID used by the drill instance |
| RecoveryPointTime | integer | no | Recovery point time. If the recovery point ID is not specified, query available recovery points based on the recovery point time |
| EipAddressId | string | no | Elastic IP Address ID bound to the drill instance |
| RecoveryEssdPerformanceLevel | string | no | PL level of the ESSD disk. Supported PL levels are determined by the minimum cloud disk size |

### Reverse register the instance that completed failover. This operation registers the instance from the…
`POST https://apizie.tech/v1/cloud:aliyun-hdr/trigger-reversed-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | no | ID of the protected server |

### Removes a protected server from the backup service
`POST https://apizie.tech/v1/cloud:aliyun-hdr/unregister-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| ServerId | string | yes | The ID of the protected server |

### Modifies the content of a recovery plan
`POST https://apizie.tech/v1/cloud:aliyun-hdr/update-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |
| RecoveryPlanId | string | no | The ID of the recovery plan |
| Name | string | no | The name of the recovery plan |
| Content | string | no | The details of the recovery plan |

### version
`POST https://apizie.tech/v1/cloud:aliyun-hdr/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://hdr.cn-shanghai.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-hdr/change-recovery-point" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Hybrid Disaster Recovery API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-hdr/change-recovery-point with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Hybrid Disaster Recovery API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Hybrid Disaster Recovery itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Hybrid Disaster Recovery API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-hdr.

### What is the status of the Alibaba Cloud Hybrid Disaster Recovery API?
Needs your own provider key (bring your own key)