/v1/cluster/protection/restriper/status

Endpoint

/v1/cluster/protection/restriper/status

GET

Get current status of restriper, including data protection status and current restriper phase (if running)

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_restriper_status_v2",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "NOT_STARTED",
        "RUNNING",
        "FINISHED"
      ],
      "description": "Restriper state (one of NOT_STARTED, RUNNING, FINISHED).:\n * `FINISHED` - FINISHED,\n * `NOT_STARTED` - NOT_STARTED,\n * `RUNNING` - RUNNING"
    },
    "phase": {
      "type": "string",
      "enum": [
        "PLANNING",
        "REPROTECT",
        "REBALANCE",
        "PARTITIONED_REBALANCE",
        "TRANSCODE"
      ],
      "description": "Restriper phase when state is RUNNING (one of PLANNING, REPROTECT, REBALANCE, PARTITIONED_REBALANCE, TRANSCODE). Empty otherwise.:\n * `PARTITIONED_REBALANCE` - PARTITIONED_REBALANCE,\n * `PLANNING` - PLANNING,\n * `REBALANCE` - REBALANCE,\n * `REPROTECT` - REPROTECT,\n * `TRANSCODE` - TRANSCODE"
    },
    "blocked_reason": {
      "description": "If state is FINISHED but restriper did not complete all required work, this field provides the reason for the work being incomplete. Empty otherwise.",
      "type": "string"
    },
    "data_at_risk": {
      "description": "True if any data is not fully protected, false otherwise.",
      "type": "boolean"
    },
    "elapsed_seconds": {
      "description": "Elapsed time since the current phase began (0 if state is not RUNNING).",
      "type": "number"
    },
    "percent_complete": {
      "description": "Percent completion of the current phase (0 if state is not RUNNING).",
      "type": "number"
    },
    "coordinator_node": {
      "description": "Restriper coordinator node ID in this quorum, where reports are being recorded.",
      "type": "number"
    }
  }
}