Check broker pre-restart

GET /v1/broker/pre_restart_probe

Check if it is safe to restart this broker.

Query parameters

  • limit integer

    Limit the number of partitions listed for each risk type (default: 128).

Responses

  • 200 application/json

    Pre-restart check result. Returns risks associated with restarting the broker, and partitions affected, if any.

    Hide response attribute Show response attribute object
    • risks object

      Partitions affected by the current broker restart, grouped by risk type. Each partition list is truncated according to the optional limit specified in the request.

      Hide risks attributes Show risks attributes object
      • rf1_offline array[string]

        Partitions with a replication factor of 1 that have a replica on the current broker.

      • full_acks_produce_unavailable array[string]

        Partitions that may reject produce requests (with acks=-1) if the current broker is restarted.

      • unavailable array[string]

        Partitions that may reject consume and produce requests if the current broker is restarted.

      • acks1_data_loss array[string]

        Partitions that may lose data produced (with acks=1) if the current broker is restarted.
GET /v1/broker/pre_restart_probe 
curl \
 --request GET 'http://localhost:9644/v1/broker/pre_restart_probe'
Response examples (200) 
{
  "risks": {
    "rf1_offline": [
      "string"
    ],
    "full_acks_produce_unavailable": [
      "string"
    ],
    "unavailable": [
      "string"
    ],
    "acks1_data_loss": [
      "string"
    ]
  }
}