Obtaining All the RAID Group Information

Introduction

Obtains the RAID Group information.

The list is sorted by the RAID Group Number in ascending order.

Request Examples

This is an example of how to obtain the RAID Group ID and Status for ten RAID Groups from a RAID Group with RAID Group Number 0.

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

This is an example of how to obtain the RAID Group ID and Name of a healthy RAID Group.

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

Response Examples

{
  "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 to display.

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

For details about the specification methods, see Property Filter.

raidgroup_id

Array of integers

RAID Group ID.

Specify the ID of the RAID Group for which you want to retrieve information.

Input criteria:

You can specify up to 256 values.

level

Array of strings

RAID Level.

Items	Description
Normal	Normal state.
Maintenance	Maintenance state.
Warning	Preventive maintenance is required.
Error	An error has occurred and maintenance is required.

Input criteria:

You can specify up to 4 values.

status

Array of strings

Status.

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

Items	Description
RAID0	Striping
RAID1	Mirroring
RAID5	High Capacity
RAID6	High Reliability
RAID10	High Performance
RAID50	Reliability
RAID6FR	RAID6 (Fast Recovery)

Input criteria:

You can specify up to 7 values.

drive_type

Array of strings

Type of the drive that configures the RAID Group.

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

assigned_cm

Array of strings

Assigned CM of the RAID Group.

Input criteria:

You can specify up to 24 values.

start_number

integer

Default: 0

The first number of the resource for which you want information.

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

integer

The identifier of the resource for which to retrieve 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 retrieve further information.

is_response_volume_id_list

boolean

Whether to return the information on the volumes that belong to the RAID Group using the Volume ID List format.

If this parameter is specified as true, the information on the volumes that belong to the RAID Group is not returned using the Volume Href List format, but returned using the Volume ID List format.

If this parameter is specified as false or is omitted, the Volume Href List format is used to return the information.

If a single RAID Group contains 16384 or more volumes, the information on all the volumes cannot be returned using the Volume Href List format.

To obtain the information on all the volumes belonging to a RAID Group that contains a large number of volumes, set this parameter as true.

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.
raidgroup_list	Array of objects The information that can be retrieved with GET /raidgroup/raidgroup_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining RAID Group 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.