Distributed

Remove peer from the cluster

Changed on

Tries to remove peer from the cluster. Will return an error if peer has shards on it.

delete/cluster/peer/{peer_id}

Request

Path parameters

peer_idinteger required

Id of the peer

Query parameters

timeoutinteger

Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

forceboolean

If true - removes peer even if it has shards/replicas on it.

Response

successful operation

timenumber float

Time spent to process this request

statusstring
resultboolean

Example response

{
  "time": 0.002,
  "status": "ok"
}

Changes

    • warning

      for the query request parameter timeout, the min was set to 1.00

    • info

      added the new optional query request parameter timeout

    • info

      added to the response property anyOf list for the response status

    • info

      removed from the response property anyOf list for the response status