Endpoint

/v1/cluster/slots/{id}

GET

Retrieve info about the disk slot, such as its capacity, type, model, etc.

Parameters

Name Description Required
id The unique ID of the disk slot Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_disk_slot",
  "type": "object",
  "properties": {
    "id": {
      "description": "Node:Slot representation identifying the slot",
      "type": "string"
    },
    "node_id": {
      "description": "Integer ID of the node containing the slot.",
      "type": "number"
    },
    "slot": {
      "description": "Integer ID of slot on the given node",
      "type": "number"
    },
    "state": {
      "type": "string",
      "enum": [
        "empty",
        "healthy",
        "missing",
        "dead",
        "wrong_node",
        "wrong_cluster",
        "wrong_version"
      ],
      "description": "Disk slot state (healthy, dead, empty):\n * `dead` - API_DEVICE_UI_STATE_DEAD,\n * `empty` - API_DEVICE_UI_STATE_EMPTY,\n * `healthy` - API_DEVICE_UI_STATE_HEALTHY,\n * `missing` - API_DEVICE_UI_STATE_MISSING,\n * `wrong_cluster` - API_DEVICE_UI_STATE_WRONG_CLUSTER,\n * `wrong_node` - API_DEVICE_UI_STATE_WRONG_NODE,\n * `wrong_version` - API_DEVICE_UI_STATE_WRONG_VERSION"
    },
    "slot_type": {
      "type": "string",
      "enum": [
        "SSD",
        "HDD",
        "Premium Page Blob",
        "Standard Page Blob",
        "Ephemeral SSD",
        "Write Tier SSD"
      ],
      "description": "Device type for slot (SSD, HDD):\n * `Ephemeral SSD` - API_DEVICE_SLOT_TYPE_EPHEMERAL_SSD,\n * `HDD` - API_DEVICE_SLOT_TYPE_SPINNING_DISK,\n * `Premium Page Blob` - API_DEVICE_SLOT_TYPE_PREMIUM_PAGE_BLOB,\n * `SSD` - API_DEVICE_SLOT_TYPE_SSD,\n * `Standard Page Blob` - API_DEVICE_SLOT_TYPE_STANDARD_PAGE_BLOB,\n * `Write Tier SSD` - API_DEVICE_SLOT_TYPE_WRITE_TIER_SSD"
    },
    "disk_type": {
      "type": "string",
      "enum": [
        "",
        "DEVICE_MEDIA_TYPE_UNKNOWN",
        "SSD",
        "HDD",
        "Premium Page Blob",
        "Standard Page Blob",
        "Ephemeral SSD",
        "Write Tier SSD"
      ],
      "description": "Type of disk, if present (SSD, HDD):\n * `` - API_DEVICE_MEDIA_TYPE_MISSING,\n * `DEVICE_MEDIA_TYPE_UNKNOWN` - API_DEVICE_MEDIA_TYPE_UNKNOWN,\n * `Ephemeral SSD` - The device type of a disk used for the read cache on object-backed clusters,\n * `HDD` - API_DEVICE_MEDIA_TYPE_SPINNING_DISK,\n * `Premium Page Blob` - API_DEVICE_MEDIA_TYPE_PREMIUM_PAGE_BLOB,\n * `SSD` - API_DEVICE_MEDIA_TYPE_SSD,\n * `Standard Page Blob` - API_DEVICE_MEDIA_TYPE_STANDARD_PAGE_BLOB,\n * `Write Tier SSD` - The device type of a disk used for the write cache on object-backed clusters"
    },
    "disk_model": {
      "description": "Disk model (empty if no disk)",
      "type": "string"
    },
    "disk_serial_number": {
      "description": "Serial number of this disk (empty if no disk)",
      "type": "string"
    },
    "capacity": {
      "description": "Capacity in bytes (0 if slot is empty)",
      "type": "string"
    },
    "raw_capacity": {
      "description": "Raw capacity in bytes (0 if slot is empty)",
      "type": "string"
    },
    "slot_command_capacity": {
      "description": "The number of in-flight I/Os this device can handle.",
      "type": "number"
    },
    "minimum_raw_capacity": {
      "description": "Minimum raw capacity in bytes for slot",
      "type": "string"
    },
    "high_endurance": {
      "description": "Is this device a high endurance model",
      "type": "boolean"
    },
    "drive_bay": {
      "description": "Drive bay label",
      "type": "string"
    },
    "led_pattern": {
      "type": "string",
      "enum": [
        "LED_PATTERN_NORMAL",
        "LED_PATTERN_LOCATE",
        "LED_PATTERN_FAILURE"
      ],
      "description": "Current state of the slot's LED:\n * `LED_PATTERN_FAILURE` - failure,\n * `LED_PATTERN_LOCATE` - locate,\n * `LED_PATTERN_NORMAL` - normal"
    }
  }
}

PATCH

Control the slot's locate LED.

Parameters

Name Description Required
id The unique ID of the disk slot Yes

Request

Schema

{
  "description": "api_disk_slot_patch",
  "type": "object",
  "properties": {
    "led_pattern": {
      "type": "string",
      "enum": [
        "LED_PATTERN_NORMAL",
        "LED_PATTERN_LOCATE",
        "LED_PATTERN_FAILURE"
      ],
      "description": "led_pattern:\n * `LED_PATTERN_FAILURE` - failure,\n * `LED_PATTERN_LOCATE` - locate,\n * `LED_PATTERN_NORMAL` - normal"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_disk_slot",
  "type": "object",
  "properties": {
    "id": {
      "description": "Node:Slot representation identifying the slot",
      "type": "string"
    },
    "node_id": {
      "description": "Integer ID of the node containing the slot.",
      "type": "number"
    },
    "slot": {
      "description": "Integer ID of slot on the given node",
      "type": "number"
    },
    "state": {
      "type": "string",
      "enum": [
        "empty",
        "healthy",
        "missing",
        "dead",
        "wrong_node",
        "wrong_cluster",
        "wrong_version"
      ],
      "description": "Disk slot state (healthy, dead, empty):\n * `dead` - API_DEVICE_UI_STATE_DEAD,\n * `empty` - API_DEVICE_UI_STATE_EMPTY,\n * `healthy` - API_DEVICE_UI_STATE_HEALTHY,\n * `missing` - API_DEVICE_UI_STATE_MISSING,\n * `wrong_cluster` - API_DEVICE_UI_STATE_WRONG_CLUSTER,\n * `wrong_node` - API_DEVICE_UI_STATE_WRONG_NODE,\n * `wrong_version` - API_DEVICE_UI_STATE_WRONG_VERSION"
    },
    "slot_type": {
      "type": "string",
      "enum": [
        "SSD",
        "HDD",
        "Premium Page Blob",
        "Standard Page Blob",
        "Ephemeral SSD",
        "Write Tier SSD"
      ],
      "description": "Device type for slot (SSD, HDD):\n * `Ephemeral SSD` - API_DEVICE_SLOT_TYPE_EPHEMERAL_SSD,\n * `HDD` - API_DEVICE_SLOT_TYPE_SPINNING_DISK,\n * `Premium Page Blob` - API_DEVICE_SLOT_TYPE_PREMIUM_PAGE_BLOB,\n * `SSD` - API_DEVICE_SLOT_TYPE_SSD,\n * `Standard Page Blob` - API_DEVICE_SLOT_TYPE_STANDARD_PAGE_BLOB,\n * `Write Tier SSD` - API_DEVICE_SLOT_TYPE_WRITE_TIER_SSD"
    },
    "disk_type": {
      "type": "string",
      "enum": [
        "",
        "DEVICE_MEDIA_TYPE_UNKNOWN",
        "SSD",
        "HDD",
        "Premium Page Blob",
        "Standard Page Blob",
        "Ephemeral SSD",
        "Write Tier SSD"
      ],
      "description": "Type of disk, if present (SSD, HDD):\n * `` - API_DEVICE_MEDIA_TYPE_MISSING,\n * `DEVICE_MEDIA_TYPE_UNKNOWN` - API_DEVICE_MEDIA_TYPE_UNKNOWN,\n * `Ephemeral SSD` - The device type of a disk used for the read cache on object-backed clusters,\n * `HDD` - API_DEVICE_MEDIA_TYPE_SPINNING_DISK,\n * `Premium Page Blob` - API_DEVICE_MEDIA_TYPE_PREMIUM_PAGE_BLOB,\n * `SSD` - API_DEVICE_MEDIA_TYPE_SSD,\n * `Standard Page Blob` - API_DEVICE_MEDIA_TYPE_STANDARD_PAGE_BLOB,\n * `Write Tier SSD` - The device type of a disk used for the write cache on object-backed clusters"
    },
    "disk_model": {
      "description": "Disk model (empty if no disk)",
      "type": "string"
    },
    "disk_serial_number": {
      "description": "Serial number of this disk (empty if no disk)",
      "type": "string"
    },
    "capacity": {
      "description": "Capacity in bytes (0 if slot is empty)",
      "type": "string"
    },
    "raw_capacity": {
      "description": "Raw capacity in bytes (0 if slot is empty)",
      "type": "string"
    },
    "slot_command_capacity": {
      "description": "The number of in-flight I/Os this device can handle.",
      "type": "number"
    },
    "minimum_raw_capacity": {
      "description": "Minimum raw capacity in bytes for slot",
      "type": "string"
    },
    "high_endurance": {
      "description": "Is this device a high endurance model",
      "type": "boolean"
    },
    "drive_bay": {
      "description": "Drive bay label",
      "type": "string"
    },
    "led_pattern": {
      "type": "string",
      "enum": [
        "LED_PATTERN_NORMAL",
        "LED_PATTERN_LOCATE",
        "LED_PATTERN_FAILURE"
      ],
      "description": "Current state of the slot's LED:\n * `LED_PATTERN_FAILURE` - failure,\n * `LED_PATTERN_LOCATE` - locate,\n * `LED_PATTERN_NORMAL` - normal"
    }
  }
}