TestFailover

Updated at:

Performs a disaster recovery drill.

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:TestFailover

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ServerId

string

No

Protected server ID

sr-000cvyfewfi7eudxml1a

RecoveryInstanceName

string

No

Instance name for the drill

test-failover-instance

RecoveryCpu

integer

No

Number of CPU cores for the drill instance

2

RecoveryMemory

integer

No

Memory size of the drill instance, in MB

4294967296

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 CPU cores and memory size.

ecs.c5.large

RecoveryUseSsd

boolean

No

Whether the drill instance uses SSD cloud disks

false

RecoveryUseEssd

boolean

No

Whether the drill instance uses ESSD cloud disks

false

RecoveryNetwork

string

No

VSwitch ID where the drill instance resides

vsw-bp1g0s2u3b2kbn46kiy53

RecoveryReserveIp

boolean

No

Whether the drill instance retains the source machine's IP address (requires the VSwitch where the drill runs to include the corresponding CIDR block)

false

RecoveryUseDhcp

boolean

No

Whether the drill instance uses DHCP to assign an IP address

false

RecoveryIpAddress

string

No

IP address of the drill instance

10.10.10.10

RecoveryPostScriptType

string

No

Script type to execute after the drill instance starts. Options: SHELL

SHELL

RecoveryPostScriptContent

string

No

Script to execute after the drill instance starts

echo \"127.0.0.1 kubernetes.docker.internal\" >> /etc/hosts

RecoveryPointId

string

No

Recovery point ID used by the drill instance

rp-0001cgurtbrvrkj2p2pp

RecoveryPointTime

integer

No

Recovery point time. If the recovery point ID is not specified, query available recovery points based on the recovery point time.

1646046000

EipAddressId

string

No

Elastic IP Address ID bound to the drill instance

eip-bp1nf283u9p060q4gim7m

RecoveryEssdPerformanceLevel

string

No

PL level of the ESSD disk. Supported PL levels are determined by the minimum cloud disk size.

PL3

Response elements

Element

Type

Description

Example

object

Code

string

Error code

200

Message

string

Error message

successful

RequestId

string

Unique request ID.

6758891B-CF5A-5CA6-BF59-633573B91140

TaskId

string

Task ID.

t-000h3k00ckeknbukn5a5

Success

boolean

Whether the call was successful.

True

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "6758891B-CF5A-5CA6-BF59-633573B91140",
  "TaskId": "t-000h3k00ckeknbukn5a5",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.