Menu
Amazon ElastiCache
API Reference (API Version 2015-02-02)

TestFailover

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>

    2. Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed

    3. Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed

    4. Cache cluster message: Recovering cache nodes <node-id>

    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

NodeGroupId

The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

Type: String

Required: Yes

ReplicationGroupId

The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

ReplicationGroup

Contains all of the attributes of a specific Redis replication group.

Type: ReplicationGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

APICallRateForCustomerExceeded

The customer has exceeded the allowed rate of API calls.

HTTP Status Code: 400

InvalidCacheClusterState

The requested cache cluster is not in the available state.

HTTP Status Code: 400

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

InvalidReplicationGroupState

The requested replication group is not in the available state.

HTTP Status Code: 400

NodeGroupNotFoundFault

The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.

HTTP Status Code: 404

ReplicationGroupNotFoundFault

The specified replication group does not exist.

HTTP Status Code: 404

TestFailoverNotAvailableFault

HTTP Status Code: 400

Example

The following example tests automatic failover on the Redis (cluster mode disabled) replication group (console: cluster) redis00. Since there is only one node group in Redis (cluster mode disabled) clusters, the NodeGroupId will always be <cluster-name>-0001.

Sample Request

https://elasticache.us-west-2.amazonaws.com/
   ?Action=TestFailover
   &NodeGroupId=redis00-0001
   &ReplicationGroupId=redis00
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20170418T192317Z
   &X-Amz-Credential=<credential>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: