Getting information about external 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 gets a list of information about external parity groups. You can get the information such as the number of LDEVs allocated to external parity groups and the usage rate of external parity groups.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID
None.
Query parameters

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • 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": [
    {
      "externalParityGroupId": "1-1",
      "numOfLdevs": 1,
      "usedCapacityRate": 100,
      "availableVolumeCapacity": 0,
      "emulationType": "OPEN-V",
      "clprId": 0,
      "externalProductId": "OPEN-V",
      "availableVolumeCapacityInKB": 0
    },
    {
      "externalParityGroupId": "1-2",
      "numOfLdevs": 0,
      "usedCapacityRate": 0,
      "availableVolumeCapacity": 40,
      "emulationType": "OPEN-V",
      "clprId": 0,
      "externalProductId": "OPEN-V",
      "availableVolumeCapacityInKB": 41943040
    }
  ]
}

Attribute

Type

Description

externalParityGroupId

string

External parity group number

numOfLdevs

int

Number of LDEVs allocated to the external parity group

usedCapacityRate

int

Usage rate of the external 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.

emulationType

string

Emulation type of the external parity group

clprId

int

Number of CLPR to which the external parity group belongs

externalProductId

string

Storage system that is connected using the external storage connection functionality of Universal Volume Manager

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

largestAvailableCapacity

long

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

The maximum capacity of the continuously free areas is output.

totalOpenVolumeCapacity

long

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

unallocatedOpenVolumeCapacity

long

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

allocatedOpenVolumeCapacity

long

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

allocatableOpenVolumeCapacity

long

From among the open volumes in the external 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 external 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.

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/external-parity-groups