全RAID Group情報の取得

GET /raidgroup

概要説明

RAID Group情報の取得。

RAID Group Numberの昇順で表示します。

リクエスト例

  • RAID Group Number 0 のRAID Groupから10個分のRAID Groupについて、RAID Group IDとStatusを取得する場合の例です。

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/raidgroup?start_number=0&count=10&fields=status"
  • 正常状態のRAID GroupのRAID Group IDとNameを取得する場合の例です。

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/raidgroup?status=Normal&fields=name"

レスポンス例

{
  "total_count": 512,
  "list_count": 1,
  "raidgroup_list": [
    {
      "raidgroup_id": 101,
      "raidgroup_href": "/api/v1/raidgroup/101",
      "number": 101,
      "name": "RAIDGROUP#101",
      "level": "RAID10",
      "raid6fr_drive_configuration": "3Dx2_2Px2_1HS",
      "assigned_cm": "00",
      "status": "Normal",
      "detail_status": "Available",
      "is_volume_raidgroup": true,
      "allocated_resource_href": "/api/v1/tpp/0",
      "capacity": 131072,
      "free_capacity": 131072,
      "maximum_free_area_size": 131072,
      "stripe_depth": 64,
      "drive_type": "Online",
      "drive_href_list": [
        "/api/v1/drive/0000",
        "/api/v1/drive/0001",
        "/api/v1/drive/0100",
        "/api/v1/drive/0101"
      ],
      "dedicated_hotspare_href_list": [
        "/api/v1/drive/000b",
        "/api/v1/drive/010b"
      ],
      "volume_href_list": [
        "/api/v1/volume/1300001",
        "/api/v1/volume/2100002"
      ]
      "volume_id_list": [
        100000,
        200000,
        300000
      ]
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

raidgroup_id

Array of integers

RAID Group ID。

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

入力条件:

  • 256個まで指定可能です。

level

Array of strings

RAID Level。
項目 説明
Normal 正常状態です。
Maintenance 保守状態です。
Warning 予防保守が必要な状態です。
Error 異常が発生し、保守が必要な状態です。

入力条件:

  • 4個まで指定可能です。

status

Array of strings

ステータス。

情報を取得したいリソースのステータスを指定します。
項目 説明
RAID0 Striping
RAID1 Mirroring
RAID5 High Capacity
RAID6 High Reliability
RAID10 High Performance
RAID50 Reliability
RAID6FR RAID6 (Fast Recovery)

入力条件:

  • 7個まで指定可能です。

drive_type

Array of strings

RAID Groupを構成する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個まで指定可能です。

assigned_cm

Array of strings

RAID Groupの担当CM。

入力条件:

  • 24個まで指定可能です。

start_number

integer

Default: 0

情報を取得したいリソースの先頭のNumber。

max_records

integer

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

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

入力条件:

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

last_get_id

integer

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

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

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

is_response_volume_id_list

boolean

RAID Groupに属するVolume情報をVolume ID List型式で応答するかどうか。

trueを指定した場合、RAID Groupに属するVolume情報を、Volume Href ListではなくVolume ID List型式で応答します。

falseを指定した場合または指定を省略した場合、Volume Href List型式で応答します。

1つのRAID GroupにVolumeが16384以上存在する場合、Volume Href List型式ではすべてのVolume情報を応答することができません。

大量にVolumeが存在するRAID Groupに属するVolume情報をすべて取得したい場合は、本Parameterでtrueを指定してください。

Responses

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

RESPONSE BODY

total_count

integer

装置に存在するResourceの総数。

フィルタリングしている場合は、条件に合致するResourceの総数です。

list_count

integer

応答するListの個数。

raidgroup_list

Array of objects

GET /raidgroup/raidgroup_idで取得できる情報を、list_count数分出力します。詳細は、RAID Group情報の取得の「Responses」を参照してください。

next_href

string

続きの情報を取得するためのLink。

一度にすべての情報を応答しきることができなかった場合に限り応答します。

例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。