全Drive情報の取得

概要説明

Drive情報を取得します。

drive_idで昇順で応答します。

リクエスト例

Drive のDrive ID、ステータス、Capacityのみを取得する場合の例です。

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

レスポンス例

{
  "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。

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。

drive_id

Array of strings

Drive ID。

情報を取得したいDrive IDを指定します。

Formatは以下です。

CE搭載Drive w0yy
- w - 16進 CE ID (0～b)
- yy - 16進 Slot Id (00～17)
DE搭載Drive xxyy
- xx - 16進 DE ID (00～ff)
- yy - 16進 Slot Id (00～17)

入力条件：

128個まで指定可能です。

enclosure_id

Array of strings

Driveが積載されているEnclosure (CE or DE)のID。

DEの場合、DE IDと一致します。

CEの場合、CE IDに0を付与したものがEnclosure IDとなります。

例えば、CE#1のEnclosure IDは"10"です。

入力条件：

256個まで指定可能です。

tpp_id

Array of integers

Thin Provisioning Pool ID。

情報を取得したいThin Provisioning PoolのIDを指定します。

入力条件：

256個まで指定可能です。

status

Array of strings

ステータス。

情報を取得したいリソースのステータスを指定します。

項目	説明
Normal	正常状態です。
Unused	実装されていますが、未使用状態です。
Maintenance	保守状態です。
Warning	予防保守が必要な状態です。
Error	異常が発生し、保守が必要な状態です。

入力条件：

5個まで指定可能です。

drive_type

Array of strings

Driveの種別。

情報を取得したい種別を指定します。

項目	説明
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

入力条件：

8個まで指定可能です。

is_hotspare

boolean

Hot Spareに登録されているかどうか。

trueを指定した場合、Hot Spareとして登録されているDriveだけが応答されます。

falseを指定した場合、Hot Spareとして登録されていないDriveだけが応答されます。

max_records

integer

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

指定可能な範囲は1～512です。

last_get_id

string

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。

internal_id

string

DriveのInternal ID。

Driveの種別がNVMe SSDまたはNVMe SSD SED以外の場合は応答しません。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

total_count	integer 装置に存在するResourceの総数。フィルタリングしている場合は、条件に合致するResourceの総数です。
list_count	integer 応答するListの個数。
drive_list	Array of objects GET /drive/drive_idで取得できる情報を、list_count数分出力します。詳細は、Drive情報の取得の「Responses」を参照してください。
next_href	string 続きの情報を取得するためのLink。一度にすべての情報を応答しきることができなかった場合に限り応答します。例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。