Getting information about parity groups

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request obtains information about all parity groups.
Note:

If you are using SCM drives, see the usage notes in the manual for the relevant storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/parity-groups

Request message

Object ID
None.
Query parameters

You can filter execution results by the specified condition and also collect additional detailed information about parity groups.

  • When filtering execution results

    Parameter

    Type

    Filtering condition

    clprId

    int

    (Optional) CLPR number

    driveTypeName

    string

    (Optional) Drive type

    For VSP 5000 series:

    • SAS
    • SSD(MLC)
    • SSD(FMC)
    • SSD
    • SCM

    For VSP E series:

    • SAS
    • SSD(MLC)
    • SSD

    For VSP G350, G370, G700, G900, VSP F350, F370, F700, F900:

    • SAS
    • SSD(MLC)
    • SSD(FMC)
    • SSD(RI)

    driveSpeed

    int

    (Optional) Drive rotation speed (rpm)

  • When collecting additional detailed information

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of information to be collected

    To specify multiple values, separate the values by using commas.

    This parameter can be used together with the parameter for filtering execution results.

    • FMC

      For the parity groups whose drive type is SSD(FMC), add detailed information about accelerated compression.

    • class

      Adds additional information from the storage system's cache.

      You can specify this item for VSP 5000 series.

      To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

Body
None.

Response message

Body
{
  "data" : [
    {
      "parityGroupId" : "1-1",
      "numOfLdevs" : 267,
      "usedCapacityRate" : 96,
      "availableVolumeCapacity" : 24,
      "raidLevel" : "RAID5",
      "raidType" : "3D+1P",
      "clprId" : 0,
      "driveType" : "DKR5C-K300SS",
      "driveTypeName" : "SAS",
      "driveSpeed" : 15000,
      "totalCapacity" : 805,
      "physicalCapacity" : 805,
      "availablePhysicalCapacity" : 24,
      "isAcceleratedCompressionEnabled" : false,
      "availableVolumeCapacityInKB" : 26103552
    }, {
      "parityGroupId" : "1-2",
      "numOfLdevs" : 8,
      "usedCapacityRate" : 3,
      "availableVolumeCapacity" : 499,
      "raidLevel" : "RAID1",
      "raidType" : "2D+2D",
      "clprId" : 0,
      "driveType" : "DKR5C-K300SS",
      "driveTypeName" : "SAS",
      "driveSpeed" : 15000,
      "totalCapacity" : 518,
      "physicalCapacity" : 518,
      "availablePhysicalCapacity" : 499,
      "isAcceleratedCompressionEnabled" : false,
      "availableVolumeCapacityInKB" : 523737912
    }, {
      "parityGroupId" : "2-1",
      "numOfLdevs" : 90,
      "usedCapacityRate" : 88,
      "availableVolumeCapacity" : 191,
      "raidLevel" : "RAID6",
      "raidType" : "6D+2P",
      "clprId" : 0,
      "driveType" : "DKR5C-K300SS",
      "driveTypeName" : "SAS",
      "driveSpeed" : 15000,
      "totalCapacity" : 1610,
      "physicalCapacity" : 1610,
      "availablePhysicalCapacity" : 191,
      "isAcceleratedCompressionEnabled" : false,
      "availableVolumeCapacityInKB" : 201149952
    }
  ]
}

Attribute

Type

Description

parityGroupId

string

Parity group number

numOfLdevs

int

Number of assigned LDEVs

usedCapacityRate

int

Usage rate of the parity group

availableVolumeCapacity

long

Available capacity (GB)

The amount of free space is output.

If the capacity is below 1 GB, the value is ignored and 0 is assumed.

availableVolumeCapacityInKB

long

Available capacity (KB)

The amount of free space is output.

raidLevel

string

RAID level

raidType

string

RAID type

clprId

int

CLPR number

driveType

string

Code indicating the drive type of the drive belonging to the parity group

driveTypeName

string

Drive type of the drive belonging to the parity group

driveSpeed

int

Rotation speed (rpm) of the drive belonging to the parity group

totalCapacity

long

Logical capacity of the parity group (GB)

If the accelerated compression setting is enabled, the expanded capacity is output.

physicalCapacity

long

Physical capacity of the parity group (GB)

For this attribute, 1 GB is equal to 1,0243 bytes.

If the value of this attribute is less than 1 GB, 0 is displayed.

availablePhysicalCapacity

long

Total available physical capacity of the parity group (GB)

For this attribute, 1 GB is equal to 1,0243 bytes.

If the value of this attribute is less than 1 GB, 0 is displayed.

isAcceleratedCompressionEnabled

boolean

Value of the accelerated compression of the parity group

  • true: Accelerated compression for the parity group is enabled.
  • false: Accelerated compression for the parity group is disabled.

If you obtained detailed information about accelerated compression

When the drive type of the parity group is SSD(FMC), if you specify FMC for the detailInfoType query parameter and then run the request, the following additional information is obtained.

Attribute

Type

Description

totalPhysicalCapacity

long

An invalid value is displayed.

isExpandedSpaceUsed

boolean

Whether LDEVs in parity groups use the expanded area

  • true: LDEVs use the expanded area
  • false: LDEVs use the physical area or are not implemented

If you run this request with class specified for detailInfoType in the query parameters, additional information from the storage system's cache is also obtained.

Attribute

Type

Description

diskAdapterPairId

int

DKB pair number of the parity group

largestAvailableCapacity

long

Maximum capacity of the non-volume areas in the parity group (KB)

The maximum capacity of the continuously free areas is output.

emulationType

string

Emulation type

totalOpenVolumeCapacity

long

Total LDEV capacity of the open volumes in the parity group (KB)

unallocatedOpenVolumeCapacity

long

From among the open volumes in the parity group, the total capacity of volumes to which paths are not allocated (KB)

allocatedOpenVolumeCapacity

long

From among the open volumes in the parity group, the total capacity of volumes to which paths are allocated (KB)

allocatableOpenVolumeCapacity

long

From among the open volumes in the parity group, the total capacity of volumes to which paths can be allocated (KB)

The total capacity of volumes that meet all of the following conditions is output.

  • No path is allocated to the volume.
  • The volume is not a pool volume.
  • The volume is not a system disk.

reservedOpenVolumeCapacity

long

From among the open volumes in the parity group, the total capacity of volumes which are reserved (KB)

The total capacity of volumes that meet all of the following conditions is output.

  • No path is allocated to the volume.
  • The volume is either a pool volume or a system disk.

totalUsablePhysicalCapacity

long

The capacity of the space that can be used for writing to the parity group or reading from the parity group (KB)

This information is output if the accelerated compression function is supported for the parity group.

Status codes

For details on the status codes of the request for this operation, see the description of HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/parity-groups