Evacuate Peer

Moves a single consumer off one peer. The consumer keeps its replica count and the server picks the replacement peer. If no peer qualifies, the request fails with a peer remap error rather than leaving the group under-replicated.

Subject

$JS.API.CONSUMER.PEER.EVACUATE.{stream}.{consumer}

Where {stream} is the stream name and {consumer} is the consumer name.

Request

A request to the JetStream $JS.API.CONSUMER.PEER.EVACUATE API

peerstringrequired

Server name or peer ID of the peer to evacuate

Min length:1

Response

A response from the JetStream $JS.API.CONSUMER.PEER.EVACUATE API

One of the following:

Option 1 (object)

errorobjectrequired

Option 2 (object)

successbooleanrequired

If the peer evacuation was successfully started

Default:false

typeconst: "io.nats.jetstream.api.v1.consumer_evacuate_peer_response"