Obtaining Drive Information

GET /drive/{drive_id}

Introduction

Obtains Drive information.

Request Examples

  • This is an example of obtaining only the Drive ID, status, and Capacity for Drive ID 0204.

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/drive/0204?fields=status,capacity"

Response Examples

{
  "drive_id": "010a",
  "drive_href": "/api/v1/drive/010a",
  "enclosure_id": "01",
  "ce_id": "0",
  "de_id": "01",
  "slot": 10,
  "status": "Normal",
  "detail_status": "Available",
  "capacity": 300,
  "speed": 15000,
  "drive_type": "Online",
  "is_advanced_format": false,
  "is_hotspare": false,
  "is_dedicated": true,
  "allocated_raidgroup_href": "/api/v1/raidgroup/1",
  "health": 0,
  "rebuild_copyback_progress": 0,
  "vendor_id": "FUJITSU",
  "product_id": "PRODUCT-00000001",
  "serial_number": "SERIAL-000000001",
  "wwn": "0000000000000000",
  "internal_id": "000000000000000000000000000000000000000000000000",
  "firmware_revision": "REV-0001"
}

Parameters

PATH PARAMETERS

drive_id

(required)

string

Drive ID.

Format is as follows:

  • Drive in CE w0yy

    • w - Hexadecimal CE ID (0 to b)

    • yy - Hexadecimal Slot ID (00 to 17)

  • Drive in DE xxyy

    • xx - Hexadecimal DE ID (00 to ff)

    • yy - Hexadecimal Slot ID (00 to 17)

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

drive_id

string

Drive ID.

Format is as follows:

  • Drive in CE w0yy

    • w - Hexadecimal CE ID (0 to b)

    • yy - Hexadecimal Slot ID (00 to 17)

  • Drive in DE xxyy

    • xx - Hexadecimal DE ID (00 to ff)

    • yy - Hexadecimal Slot ID (00 to 17)
drive_href

string

Resource link of the drive.
enclosure_id

string

ID of the Enclosure (CE or DE) where the Drive is installed.

For DE, it matches the DE ID.

For CE, the Enclosure ID is the CE ID plus 0.

For example, the Enclosure ID of CE#1 is "10".
ce_id

string

ID of CE where the Drive is installed.

If the Drive is installed in the CE, the query is responded to with this item.

The format is a single-digit hexadecimal number.
de_id

string

ID of DE where the Drive is installed.

If the Drive is installed in the DE, the query is responded to with this item.

The format is a double-digit hexadecimal number.
slot

integer

Slot number where the Drive is installed.

It is displayed as a decimal.
status

string

Status.
Item Description
Normal Normal state.
Unused Implemented but unused.
Maintenance Maintenance state.
Warning Preventive maintenance is required.
Error An error has occurred and maintenance is required.
detail_status

string

Detailed status.
Item Description
Available The drive state is normal. Drives are used for RAID Groups or other items.
Spare Drive is registered as a Hotspare.
Present Drive is unused.
Readying The Drive is being started.
Rebuild-Copyback Drive is in Rebuild/Copyback.
Redundant_Copy Drive is in Redundant Copy.
Not_Supported Drive is not supported.
Not_Exist Drive is no longer recognized.
Failed_Usable Drive has failed with a RAID Group failure.
Broken Drive has failed.
capacity

integer

Drive capacity.

The unit is MB.

It is different from the capacity on the product.
speed

integer

Drive speed.

The unit is rpm.

It does not respond if the Drive type is SAS SSD, SAS SSD SED, NVMe SSD, or NVMe SSD SED.
drive_type

string

Drive type.
Item Description
Online Online HDD
Nearline Nearline HDD
SSD SAS SSD
NVMe_SSD NVMe SSD
Online_SED Online HDD SED
Nearline_SED Nearline HDD SED
SSD_SED SAS SSD SED
NVMe_SSD_SED NVMe SSD SED
is_advanced_format

boolean

Whether the Drive supports Advanced Format.

It does not respond if the Drive type is SAS SSD, SAS SSD SED, NVMe SSD, or NVMe SSD SED.
is_hotspare

boolean

Indicates whether the drive is registered as a Hot Spare.
is_dedicated

boolean

Indicates whether the drive is registered as a Dedicated Hot Spare.

Responds only if is_hotspare is true.

If true, it is registered as a Dedicated Hot Spare; if false, it is registered as a Global Hot Spare.
allocated_raidgroup_href

string

The Link to the RAID Group that is configured with the Drive.

A link to a RAID Group is returned if the Drive is a configuration drive (including Dedicated Hot Spares) of a RAID Group.

It does not respond if the Drive is not a configuration drive of a RAID Group.

For tenant users, it does not respond if the Drive is not a configuration drive of a RAID Group that belongs to the tenant of the current user.
allocated_resource_href

string

The Link to the Resource that is configured with the Drive.

A Link to a Thin Provisioning Pool is returned if the Drive is a configuration drive of a Thin Provisioning Pool.

A Link to a Flexible Tier Pool is returned if the Drive is a configuration drive of a Flexible Tier Pool.

A link to a RAID Group is returned if the Drive is a configuration drive (including Dedicated Hot Spares) of a RAID Group.

It does not respond if the Drive is not used.

For tenant users, it does not respond if the Drive is not a configuration drive of a Resource that belongs to the tenant of the current user.
health

integer

The remaining usable drive capacity (life).

As the remaining available capacity decreases, the value decreases.

The unit is %.

It responds if the Drive type is SAS SSD, SAS SSD SED, NVMe SSD, or NVMe SSD SED.

However, it does not respond during a data deletion or when the available capacity cannot be obtained.
rebuild_copyback_progress

integer

Rebuild or Copyback progress percentage.

The unit is %.

It is returned if Rebuild or Copyback is running.
vendor_id

string

The manufacturer name of the Drive.
product_id

string

The product name of the Drive.
serial_number

string

The serial number of the Drive.
wwn

string

The WWN of the Drive.

It does not respond if the Drive type is NVMe SSD or NVMe SSD SED.
internal_id

string

Internal ID of the Drive.

It does not respond if the Drive type is not NVMe SSD or NVMe SSD SED.
firmware_revision

string

Drive firmware revision.