Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Search Manager Options REST API

  • reference
    +

    Overview

    The Search Manager Options REST API is provided by the Search service. This API enables you to set Search manager options; in particular, to configure rebalance based on file transfer.

    Version information

    Version : 7.6

    Host information

    {scheme}://{host}:{port}

    The URL scheme, host, and port are as follows.

    Component Description

    scheme

    The URL scheme. Use https for secure access.

    Values: http, https
    Example: http

    host

    The host name or IP address of a node running the Search Service.

    Example: localhost

    port

    The Search Service REST port. Use 18094 for secure access.

    Values: 8094, 18094
    Example: 8094

    Examples on this page

    In the HTTP request examples:

    • $HOST is the host name or IP address of a node running the Search Service.

    • $USER is the user name of an authorized user — see Security.

    • $PASSWORD is the password to connect to Couchbase Server.

    Resources

    This section describes the operations available with this REST API.

    Modify Search Manager Options

    Modify Search Manager Options

    PUT /api/managerOptions

    Description

    Sets Search manager options. Note that only one setting is available: disableFileTransferRebalance.

    The Search Service automatically partitions its indexes across all Search nodes in the cluster, ensuring optimal distribution, following rebalance.

    To achieve this, in versions of Couchbase Server prior to 7.1, by default, partitions needing to be newly created were entirely built, on their newly assigned nodes. In 7.1+, by default, new partitions are created by the transfer of partition files from old nodes to new nodes: this significantly enhances performance. This is an Enterprise-only feature, which requires all Search Service nodes either to be running 7.1 or later; or to be running 7.0.2, with the feature explicitly switched on by means of this endpoint. Note that users of 7.1+ can explicitly switch the feature off by means of this endpoint; in which case partition build is used to establish new partitions, rather than file transfer.

    During file transfer, should an unresolvable error occur, file transfer is automatically abandoned, and partition build is used instead.

    Consumes

    • application/json

    Produces

    • application/json

    Parameters

    Body Parameter

    Name Description Schema

    Body
    optional

    An object specifying Search manager options.

    Options

    Responses

    HTTP Code Description Schema

    200

    The operation was successful.

    Response

    401

    Failure to authenticate. The user name or password may be incorrect.

    Response

    404

    Object not found. The URL may be incorrectly specified.

    Response

    405

    Method not allowed. The method may be incorrectly specified.

    Response

    Security

    Type Name

    http (basic)

    Default

    Example HTTP Request

    The following example disables the creation of new partitions by means of file transfer.

    Curl request
    curl -X PUT http://$HOST:8094/api/managerOptions \
-u $USER:$PASSWORD \
-H "Content-type:application/json" \
-d '{"disableFileTransferRebalance": "true" }'

    From this point, Search Service index partitions are built on the new nodes assigned to them during rebalance.

    The following example re-enables the creation of new partitions by means of file transfer:

    Curl request
    curl -X PUT http://$HOST:8094/api/managerOptions \
-u $USER:$PASSWORD \
-H "Content-type:application/json" \
-d '{"disableFileTransferRebalance": "false" }'

    From this point, Search Service index partitions are again created by file transfer, on the new nodes assigned to them during rebalance.

    Example HTTP Response

    Response 200
    {
  "status": "ok"
}
    Response 405
    {
  "error": "Method not allowed for endpoint",
  "status": "fail"
}

    Definitions

    This section describes the properties consumed and returned by this REST API.

    Options
    Response

    Options

    Object

    Property Schema

    disableFileTransferRebalance
    optional

    If the value is false (the default), new Search Service partitions are created during rebalance by means of partition file transfer.

    If the value is true, partitions are created by means of partition build, from scratch, over DCP connections from the Data Service.

    Default: false

    Boolean

    Response

    Object

    Property Schema

    status
    required

    The status of the operation.

    String

    error
    optional

    The error message, if the operation was not successful.

    String

    Security

    The Search REST APIs support HTTP basic authentication. Pass your credentials through HTTP headers.

    Default

    Type : http

    For more information, see Roles.

    See Also

    • An overview of rebalance for all services is provided at Rebalance.

    • An overview of the REST API for the Search Service is provided at Search API.

    • An architectural summary of the Search Service is provided at Search Service Architecture.