Endpoint

/v1/cluster/restriper/status

GET

Get current status of restriper, including data protection status and current restripe phase (if running). This API is deprecated in favor of /v1/cluster/protection/restriper/status after v5.3.4.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_restriper_status",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "RUNNING",
        "NOT_RUNNING",
        "BLOCKED"
      ],
      "description": "Restriper status (one of RUNNING, BLOCKED, NOT_RUNNING).:\n * `BLOCKED` - API_RESTRIPER_STATE_BLOCKED,\n * `NOT_RUNNING` - API_RESTRIPER_STATE_NOT_RUNNING,\n * `RUNNING` - API_RESTRIPER_STATE_RUNNING"
    },
    "data_at_risk": {
      "description": "True if any data in the cluster needs to be reprotected, false otherwise.",
      "type": "boolean"
    },
    "blocked_reason": {
      "description": "If status is BLOCKED, this field provides more information.",
      "type": "string"
    },
    "phase": {
      "type": "string",
      "enum": [
        "PLANNING",
        "REPROTECT",
        "REBALANCE",
        "PARTITIONED_REBALANCE",
        "TRANSCODE",
        ""
      ],
      "description": "Restriper phase when status is RUNNING (one of PLANNING, REPROTECT, REBALANCE, PARTITIONED_REBALANCE, TRANSCODE), empty otherwise.:\n * `` - API_RESTRIPER_PHASE_NOT_RUNNING,\n * `PARTITIONED_REBALANCE` - API_RESTRIPER_PHASE_PARTITIONED_REBALANCE,\n * `PLANNING` - API_RESTRIPER_PHASE_PLANNING,\n * `REBALANCE` - API_RESTRIPER_PHASE_REBALANCE,\n * `REPROTECT` - API_RESTRIPER_PHASE_REPROTECT,\n * `TRANSCODE` - API_RESTRIPER_PHASE_TRANSCODING"
    },
    "elapsed_seconds": {
      "description": "How long since the current phase began (0 if status != RUNNING).",
      "type": "number"
    },
    "estimated_seconds_left": {
      "description": "How much longer the current phase is expected to take (UINTMAX if status != RUNNING).",
      "type": "number"
    },
    "percent_complete": {
      "description": "Percent of work completed by the current phase.",
      "type": "number"
    },
    "coordinator_node": {
      "description": "Restriper coordinator for this quorum (where reports will get stored).",
      "type": "number"
    }
  }
}