Obtaining All the Drive Information

Introduction

Obtains Drive information.

The Drive information is returned by drive_id in ascending order.

Request Examples

This is an example of obtaining only the Drive ID, status, and Capacity of a Drive.

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

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "drive_list": [
    {
      "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

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.

drive_id

Array of strings

Drive ID.

Specify the Drive ID for which you want information.

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)

Input criteria:

You can specify up to 128 values.

enclosure_id

Array of strings

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".

Input criteria:

You can specify up to 256 values.

tpp_id

Array of integers

Thin Provisioning Pool ID.

Specify the ID of the Thin Provisioning Pool for which you want information.

Input criteria:

You can specify up to 256 values.

status

Array of strings

Status.

Specify the status of the resource for which you want information.

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.

Input criteria:

You can specify up to 5 values.

drive_type

Array of strings

Drive type.

Specify the type for which you want information.

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

Input criteria:

You can specify up to 8 values.

is_hotspare

boolean

Indicates whether the drive is registered as a Hot Spare.

If true, only the drives registered as Hot Spares will be returned.

If false, only the drives not registered as Hot Spares will be returned.

max_records

integer

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

The range of allowed values is 1 to 512.

last_get_id

string

The identifier of the resource for which to obtain further information.

If all resources matching the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to obtain further information.

internal_id

string

Internal ID of the Drive.

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

Responses

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

RESPONSE BODY

total_count	integer The total number of Resources present in the device. If a filter is applied, this is the total number of Resources that meet the criteria.
list_count	integer Number of Lists to respond.
drive_list	Array of objects The information that can be obtained with GET /drive/drive_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Drive Information.
next_href	string Link to get more information. This item is returned only when it is not possible to respond all information at once. For example, this item is responded if there are more Resources that match the response condition than the number specified by max_records.