Cancel Move

Cancels an in-progress stream reconfiguration and rolls the stream back to the config and peers it had before the reconfiguration started. This covers any in-flight desired state, not only moves: a scale up or down and a retention change are rolled back the same way.

Subject

• $JS.API.STREAM.CANCEL_MOVE.{stream}
• $JS.API.ACCOUNT.STREAM.CANCEL_MOVE.{account}.{stream}

Where {stream} is the name of the stream and {account} is the account that holds it.

The first subject is used from the account that owns the stream. The second cancels a move on behalf of another account and is only available from the system account.

Response

A response from the JetStream $JS.API.STREAM.CANCEL_MOVE API

One of the following:

Option 1 (object)

configobjectrequired

The active configuration for the Stream

stateobjectrequired

Detail about the current State of the Stream

createdstring<date-time>required

Timestamp when the stream was created

A point in time in RFC3339 format including timezone, though typically in UTC

tsstring<date-time>

The server time the stream info was created

A point in time in RFC3339 format including timezone, though typically in UTC

clusterobject

mirrorobject

Information about an upstream stream source in a mirror

sourcesobject[]

Streams being sourced into this Stream

alternatesobject[]

List of mirrors sorted by priority

domainstring

The JetStream domain the stream is in

Option 2 (object)

errorobjectrequired

typeconst: "io.nats.jetstream.api.v1.stream_cancel_move_response"required