ForcedFailover

Updated at:

Performs a forced failover.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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.