Managing Auto-Failover

    +
    Auto-failover is managed by means of the the GET /settings/autoFailover HTTP method and URI.

    Description

    This section provides information about retrieving, enabling, disabling, and resetting auto-failover.

    Table 1. Auto-Failover Endpoints
    HTTP method URI path Description

    GET

    /settings/autoFailover

    Retrieves automatic-failover settings. Uses the following parameters:

    • enabled. Indicates whether automatic failover is enabled (a value of true) or disabled (a value of false).

    • timeout. Returns an integer between 5 and 3600, which specifies the number of seconds set to elapse, after a node has become unavailable, before automatic failover is triggered.

    • count. This parameter represents how many sequential auto-failover events have occurred since the parameter was itself last reset, to a value of 0, through administrator intervention.

    POST

    /settings/autoFailover

    Enables and disables automatic failover. Uses the following paramenters:

    • enabled=[true|false]. Enables or disables automatic failover.

    • timeout= number-of-seconds. Integer between 5 and 3600. Specifies the number of seconds that must elapse after a node has become unavailable, before automatic failover is triggered.

    • maxCount= number-of-events. Specifies the number of auto-failover events that are sequentially handled before user intervention is required. An event might consist of one node failing over; or alternatively, of an entire server group failing over. The maximum allowed value is three. The default value is one.

    • failoverServerGroup=[true|false]&maxCount= number-of-seconds. Enables or disables automatic failover for server groups, and specifies the number of seconds that must elapse after a node has become unavailable, before automatic failover is triggered. Do not enable failover for server groups unless you have set up three of more server groups, and have the capacity to absorb the load of any failed-over group.

    • failoverOnDataDiskIssues[enabled]=[true|false]&failoverOnDataDiskIssues[timePeriod]= number-of-seconds. Integer between 5 and 3600. Enables or disables automatic failover for any sustained disk read/write failure, after the specied time-period has elapsed

    POST

    /settings/autoFailover/resetCount

    Resets automatic failover count to 0.

    Auto-Failover and Durability

    Couchbase Server provides durability, which ensures the greatest likelihood of data-writes surviving unexpected anomalies, such as node-outages. The auto-failover maximum should be established to support guarantees of durability. See Durability, for information.