A newer version of this documentation is available.

View Latest

Configuring Rebalance Retries

  • reference
    +

    HTTP methods and URI

    GET /pools/default/retryRebalance
    
    POST /pools/default/retryRebalance

    Description

    This gets and sets the configuration for rebalance retries. For an overview of rebalance and rebalance retries, see Rebalance.

    Curl Syntax

    curl -X GET -u <administrator>:<password>
    http://<host>:<port>/pools/default/retryRebalance
    
    curl -X POST -u Administrator:password
    http://<host>:<port>/settings/retryRebalance
        -d enabled=[ true | false ]
        -d afterTimePeriod=[number-of-seconds]
        -d maxAttempts=[number-of-attempts]

    The afterTimePeriod parameter specifies the number of seconds that must elapse between successive retries: this must be an integer in the range of 5 to 3600.

    The maxAttempts parameter specifies the maximum number of successive retries to be attempted: this must be an integer in the range of 1 to 3.

    Responses

    Success gives 200 OK, and returns an object containing status on pending rebalance retries. Failure to authenticate gives 401 Unauthorized. A malformed URI gives 404 Object Not Found.

    Example

    To obtain the cluster’s current rebalance settings by means of the REST API, use the GET /settings/retryRebalance http method and URI, as follows:

    curl -X GET -u Administrator:password \
    http://10.143.192.101:8091/settings/retryRebalance

    If successful, the command returns the following object:

    {"enabled":true,"afterTimePeriod":200,"maxAttempts":3}

    This output shows that rebalance retry is enabled, with 200 seconds required to elapse before a retry is attempted, and a maximum of 3 retries possible.

    To change the rebalance settings, use the POST method with the same URI, specifying appropriate values:

    curl -X POST -u Administrator:password \
    http://10.143.192.101:8091/settings/retryRebalance \
    -d enabled=false \
    -d afterTimePeriod=100 \
    -d maxAttempts=2

    If successful, the command returns the following object:

    {"enabled":false,"afterTimePeriod":100,"maxAttempts":2}

    This verifies that rebalance retry has been disabled, the required period between retries changed to 100 seconds, and the maximum number of retries changed to 2.

    See Also

    For an overview of rebalance with the Data Service and other services, see Rebalance. For practical examples of adding a node, rebalancing, and cancelling rebalance retries, see Add a Node and Rebalance.

    For information on using the REST API to retrieve current status on and to cancel pending rebalance retries, see Get Rebalance-Retry Status abd Cancel Rebalance Retries. For information on obtaining and reading rebalance reports, see the Rebalance Reference.