Endpoint

/v2/upgrade/status

GET

Retrieve the current status of the upgrade system. This API is deprecated in favor of /v3/upgrade/status.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "upgrade_status",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "UPGRADE_STATE_IDLE",
        "UPGRADE_STATE_PREPARING",
        "UPGRADE_STATE_PREPARED",
        "UPGRADE_STATE_COMMITTING",
        "UPGRADE_STATE_COMMITTED",
        "UPGRADE_STATE_REBOOTING"
      ],
      "description": "state:\n * `UPGRADE_STATE_COMMITTED` - UPGRADE_STATE_COMMITTED,\n * `UPGRADE_STATE_COMMITTING` - UPGRADE_STATE_COMMITTING,\n * `UPGRADE_STATE_IDLE` - UPGRADE_STATE_IDLE,\n * `UPGRADE_STATE_PREPARED` - UPGRADE_STATE_PREPARED,\n * `UPGRADE_STATE_PREPARING` - UPGRADE_STATE_PREPARING,\n * `UPGRADE_STATE_REBOOTING` - UPGRADE_STATE_REBOOTING"
    },
    "progress": {
      "description": "progress",
      "type": "number"
    },
    "settings": {
      "description": "settings",
      "type": "object",
      "properties": {
        "install_path": {
          "description": "install_path",
          "type": "string"
        },
        "target_version": {
          "description": "target_version",
          "type": "string"
        },
        "upgrade_type": {
          "type": "string",
          "enum": [
            "SOFTWARE_ONLY",
            "SOFTWARE_AND_PLATFORM"
          ],
          "description": "upgrade_type:\n * `SOFTWARE_AND_PLATFORM` - SOFTWARE_AND_PLATFORM,\n * `SOFTWARE_ONLY` - SOFTWARE_ONLY"
        },
        "auto_commit": {
          "description": "auto_commit",
          "type": "boolean"
        },
        "do_rolling_reboot": {
          "description": "do_rolling_reboot",
          "type": "boolean"
        },
        "num_nodes_to_reboot": {
          "description": "num_nodes_to_reboot",
          "type": "number"
        }
      }
    },
    "error_info": {
      "description": "error_info",
      "type": "string"
    }
  }
}