Getting information about a specific parity group

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 gets information about a specific parity group by specifying the parity group number. You can get detailed information about individual parity groups.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the parityGroupId value obtained by getting information about the parity group.

Parameter

Type

Description

parityGroupId

string

(Required) Parity group number

Specify concatenated parity groups in the same way as the above.

If the concatenated parity groups are 1-3-1, 1-3-2, or 1-3-3, specify as follows:

"parityGroupId": "1-3" 
Query parameters
None.
Body
None.

Response message

Body
{
  "parityGroupId": "1-2",
  "numOfLdevs": 8,
  "usedCapacityRate": 3,
  "availableVolumeCapacity": 499,
  "raidLevel": "RAID1",
  "raidType": "2D+2D",
  "clprId": 0,
  "driveType": "DKR5C-K300SS",
  "driveTypeName": "SAS",
  "driveSpeed": 15000,
  "isCopyBackModeEnabled": true,
  "isEncryptionEnabled": false,
  "totalCapacity": 518,
  "physicalCapacity": 518,
  "availablePhysicalCapacity": 499,
  "isAcceleratedCompressionEnabled": false,
  "spaces": [
    {
      "partitionNumber": 0,
      "ldevId": 8672,
      "status": "NML",
      "lbaLocation": "0x000000000000",
      "lbaSize": "0x000000039180"
    }, {
      "partitionNumber": 1,
      "ldevId": 8673,
      "status": "NML",
      "lbaLocation": "0x000000039180",
      "lbaSize": "0x0000010a7000"
    },...
  ],
  "availableVolumeCapacityInKB": 523737912
}

Attribute

Type

Description

parityGroupId

string

Parity group number

numOfLdevs

int

Number of LDEVs in the parity group

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 is output.

driveTypeName

string

Drive type of the drive that belongs to the parity group

driveSpeed

int

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

isCopyBackModeEnabled

boolean

Value of the copy back mode setting of the parity group

  • true: Copy back mode is enabled.
  • false: Copy back mode is disabled.

isEncryptionEnabled

boolean

Value of the encryption setting of the parity group

  • true: Encryption is enabled.
  • false: Encryption is disabled.

totalCapacity

long

Logical capacity of the parity group (GB)

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 setting of the parity group

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

spaces

object[]

The following attributes related to free space and the LDEV defined in the parity group are output:

  • partitionNumber (long)

    Partition number of the partition created by partitioning the parity group

  • ldevId (int)

    LDEV number

  • status (string)

    LDEV status

    • NML: The LDEV is implemented, or the free space is determined.
    • REG: An LDEV is being created.
    • DEL: An LDEV is being deleted.
  • lbaLocation (string)

    Starting location of the LBA of the partition in the parity group (in a multiple of 512 bytes)

  • lbaSize (string)

    Size of the partition in the parity group (in a multiple of 512 bytes)

Status codes

For details on the status codes of the request for this operation, see the description on 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/1-1