ForcedFailover
Performs a forced failover.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdr:ForcedFailover |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ServerId |
string |
No |
The ID of the protected server. |
sr-000ih1rl47q6hksc910d |
| RecoveryInstanceName |
string |
No |
The name of the failover instance. |
HDR_Recovery-sr-000bzkmmlwghq3soqry2 |
| RecoveryCpu |
integer |
No |
The number of vCPUs for the failover instance. |
4 |
| RecoveryMemory |
integer |
No |
The memory size of the failover instance. |
4294967296 |
| RecoveryInstanceType |
string |
No |
The instance type of the failover instance. |
ecs.r5.3xlarge |
| RecoveryUseSsd |
boolean |
No |
Indicates whether the cloud disks of the failover instance are solid-state drives (SSDs). |
false |
| RecoveryUseEssd |
boolean |
No |
Indicates whether the cloud disks of the failover instance are Enhanced SSDs (ESSDs). |
false |
| RecoveryNetwork |
string |
No |
The ID of the vSwitch where the failover instance is located. |
vsw-bp1fh05y7ybq9kep6rtwu |
| RecoveryReserveIp |
boolean |
No |
Indicates whether the failover instance retains the IP address of the source server. |
false |
| RecoveryUseDhcp |
boolean |
No |
Indicates whether the failover instance uses Dynamic Host Configuration Protocol (DHCP) to assign an IP address. |
false |
| RecoveryIpAddress |
string |
No |
The IP address that is manually specified for the failover instance. |
192.168.2.2 |
| RecoveryPostScriptType |
string |
No |
The type of the script to execute after the failover instance starts. |
SHELL |
| RecoveryPostScriptContent |
string |
No |
The content of the script to execute after the failover instance starts. |
echo \"127.0.0.1 kubernetes.docker.internal\" >> /etc/hosts |
| RecoveryPointId |
string |
No |
The recovery point ID. |
rp-000184qxs690bth6jyqn |
| RecoveryPointTime |
integer |
No |
The time of the recovery point. |
1636526948 |
| EipAddressId |
string |
No |
The ID of the elastic network interface (ENI) that is attached to the instance for failover. |
eip-bp1x7nua6eab8m4vsis9k |
| RecoveryEssdPerformanceLevel |
string |
No |
The performance level (PL) of the ESSD. The supported PL is determined by the minimum cloud disk size. |
PL2 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The error code. |
200 |
| Message |
string |
The error message. |
successful |
| RequestId |
string |
The request ID. |
26DF0E81-08E2-5AE3-96AA-05F5F826261C |
| TaskId |
string |
The task ID. |
t-000ios55mggw4ifiy3nc |
| Success |
boolean |
Indicates whether the request was successful. |
True |
Examples
Success response
JSON format
{
"Code": "200",
"Message": "successful",
"RequestId": "26DF0E81-08E2-5AE3-96AA-05F5F826261C",
"TaskId": "t-000ios55mggw4ifiy3nc",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.