Getting summary information about storage systems

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
This request gets summary information about storage systems.
Note:
  • You can use this API function 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".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/storage-summaries/instance

Request message

Object ID
Specify a value for instance. For objects that have only one instance, the value of instance is a fixed value (the object ID).
Query parameters

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • parityGroupCapacity

    Gets additional capacity information about parity groups.

Body
None.

Response message

Body
{
  "name" : "VSP 5500",
  "svpMicroVersion" : "90-01-40/02",
  "rmiServerVersion" : "10_00_05",
  "numOfDiskBoards" : 8,
  "cacheMemoryCapacity" : 169984,
  "numOfSpareDrives" : 0,
  "totalOpenVolumeCapacity" : 5487,
  "totalOpenVolumeCapacityInKB" : 5754301448,
  "allocatedOpenVolumeCapacity" : 1853,
  "allocatedOpenVolumeCapacityInKB" : 1943911065,
  "allocatableOpenVolumeCapacity" : 877,
  "allocatableOpenVolumeCapacityInKB" : 919741295,
  "unallocatedOpenVolumeCapacity" : 3633,
  "unallocatedOpenVolumeCapacityInKB" : 3810390383,
  "reservedOpenVolumeCapacity" : 2756,
  "reservedOpenVolumeCapacityInKB" : 2890649088,
  "allocatedOpenVolumePhysicalCapacity" : 760,
  "allocatedOpenVolumePhysicalCapacityInKB" : 797214657,
  "allocatableOpenVolumePhysicalCapacity" : 328,
  "allocatableOpenVolumePhysicalCapacityInKB" : 344242149,
  "reservedOpenVolumePhysicalCapacity" : 1745,
  "reservedOpenVolumePhysicalCapacityInKB" : 1829765120,
  "allocatedMainframeVolumeCapacity" : 10,
  "allocatedMainframeVolumeCapacityInKB" : 11397000,
  "reservedMainframeVolumeCapacity" : 9,
  "reservedMainframeVolumeCapacityInKB" : 9744000,
  "totalAllocatedVolumeCapacity" : 1864,
  "totalAllocatedVolumeCapacityInKB" : 1955308065,
  "totalUnallocatedVolumeCapacity" : 3643,
  "totalUnallocatedVolumeCapacityInKB" : 3820134383,
  "totalReservedVolumeCapacity" : 2766,
  "totalReservedVolumeCapacityInKB" : 2900393088,
  "totalMainframeVolumeCapacity" : 20,
  "totalMainframeVolumeCapacityInKB" : 21141000,
  "totalVolumeCapacity" : 5507,
  "totalVolumeCapacityInKB" : 5775442448,
  "numOfOpenVolumes" : 6502,
  "numOfAllocatedOpenVolumes" : 509,
  "numOfAllocatableOpenVolumes" : 5671,
  "numOfReservedOpenVolumes" : 322
}

In the descriptions in this table, the following volumes include internal volumes and external volumes:

  • Open system volumes
  • Mainframe volumes
  • Intermediate volumes

Attribute

Type

Description

name

string

Name of the storage system

svpMicroVersion

string

Microcode version of the SVP

rmiServerVersion

string

Version of the RMI server

numOfDiskBoards

int

Number of disk boards

cacheMemoryCapacity

long

Current cache capacity (MB)

numOfSpareDrives

int

Number of spare drives

totalOpenVolumeCapacity

long

The total capacity of the open system volumes (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalOpenVolumeCapacityInKB

long

The total capacity of the open system volumes (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatedOpenVolumeCapacity

long

From among the open system volumes, the total capacity of volumes to which LU paths are allocated or to which namespaces are set (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatedOpenVolumeCapacityInKB

long

From among the open system volumes, the total capacity of volumes to which LU paths are allocated or to which namespaces are set (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatableOpenVolumeCapacity

long

From among the open system volumes, the total capacity of volumes to which LU paths can be allocated or to which namespaces can be set (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatableOpenVolumeCapacityInKB

long

From among the open system volumes, the total capacity of volumes to which LU paths can be allocated or to which namespaces can be set (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

unallocatedOpenVolumeCapacity

long

From among the open system volumes, the total capacity of volumes to which LU paths are not allocated and to which namespaces are not set (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

unallocatedOpenVolumeCapacityInKB

long

From among the open system volumes, the total capacity of volumes to which LU paths are not allocated and to which namespaces are not set (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

reservedOpenVolumeCapacity

long

From among the open system volumes, the total capacity of reserved volumes, pool volumes, and the S-VOLs of snapshots (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

reservedOpenVolumeCapacityInKB

long

From among the open system volumes, the total capacity of reserved volumes, pool volumes, and the S-VOLs of snapshots (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatedOpenVolumePhysicalCapacity

long

From among the open system volumes, the total capacity of volumes to which LU paths are allocated or to which namespaces are set (GB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

allocatedOpenVolumePhysicalCapacityInKB

long

From among the open system volumes, the total capacity of volumes to which LU paths are allocated or to which namespaces are set (KB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

allocatableOpenVolumePhysicalCapacity

long

From among the open system volumes, the total capacity of volumes to which LU paths can be allocated or to which namespaces can be set (GB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

allocatableOpenVolumePhysicalCapacityInKB

long

From among the open system volumes, the total capacity of volumes to which LU paths can be allocated or to which namespaces can be set (KB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

reservedOpenVolumePhysicalCapacity

long

From among the open system volumes, the total capacity of reserved volumes and pool volumes (GB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

reservedOpenVolumePhysicalCapacityInKB

long

From among the open system volumes, the total capacity of reserved volumes and pool volumes (KB)

This is the total capacity of physical volumes, excluding the capacity of DP volumes and other virtual volumes.

numOfOpenVolumes

int

Total number of open system volumes

numOfAllocatedOpenVolumes

int

Total number of open system volumes to which LU paths are allocated or to which namespaces are set

numOfAllocatableOpenVolumes

int

Total number of open system volumes to which LU paths are not allocated and to which namespaces are not set

numOfReservedOpenVolumes

int

From among the open system volumes, the total number of reserved volumes, pool volumes, and the S-VOLs of snapshots

allocatedMainframeVolumeCapacity

long

From among the mainframe volumes and intermediate volumes, the total capacity of normal volumes (excluding reserved volumes and pool volumes) (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

allocatedMainframeVolumeCapacityInKB

long

From among the mainframe volumes and intermediate volumes, the total capacity of normal volumes (excluding reserved volumes and pool volumes) (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

reservedMainframeVolumeCapacity

long

From among the mainframe volumes and intermediate volumes, the total capacity of reserved volumes, pool volumes, and the S-VOLs of snapshots (GB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

reservedMainframeVolumeCapacityInKB

long

From among the mainframe volumes and intermediate volumes, the total capacity of reserved volumes, pool volumes, and the S-VOLs of snapshots (KB)

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalAllocatedVolumeCapacity

long

Total capacity of the volumes (in GB) to which LU paths are allocated or to which namespaces are set from among the open system volumes, and normal volumes (excluding reserved volumes and pool volumes) from among the mainframe volumes and intermediate volumes

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalAllocatedVolumeCapacityInKB

long

Total capacity of the volumes (in KB) to which LU paths are allocated or to which namespaces are set from among the open system volumes, and normal volumes (excluding reserved volumes and pool volumes) from among the mainframe volumes and intermediate volumes

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalUnallocatedVolumeCapacity

long

Total capacity of the volumes (in GB) to which LU paths are not allocated and to which namespaces are not set from among the open system volumes, and the reserved volumes, pool volumes, and the S-VOLs of snapshots from among the mainframe volumes and intermediate volumes

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalUnallocatedVolumeCapacityInKB

long

Total capacity of the volumes (in KB) to which LU paths are not allocated and to which namespaces are not set from among the open system volumes, and the reserved volumes, pool volumes, and the S-VOLs of snapshots from among the mainframe volumes and intermediate volumes

This total capacity includes the capacity of DP volumes and other virtual volumes.

totalReservedVolumeCapacity

long

Total number of reserved volumes, pool volumes, and the S-VOLs of snapshots (GB)

totalReservedVolumeCapacityInKB

long

Total number of reserved volumes, pool volumes, and the S-VOLs of snapshots (KB)

totalMainframeVolumeCapacity

long

Total capacity of the mainframe volumes and intermediate volumes (GB)

totalMainframeVolumeCapacityInKB

long

Total capacity of the mainframe volumes and intermediate volumes (KB)

totalVolumeCapacity

long

Total capacity of the open system volumes, mainframe volumes, and intermediate volumes (GB)

totalVolumeCapacityInKB

long

Total capacity of the open system volumes, mainframe volumes, and intermediate volumes (KB)

If you run this request with parityGroupCapacity specified for the query parameter detailInfoType, capacity information about parity groups is also obtained.

Attribute

Type

Description

totalAvailableParityGroupCapacity

long

Total free capacity of available parity groups and external parity groups (GB)

totalAvailableParityGroupCapacityInKB

long

Total free capacity of available parity groups and external parity groups (KB)

largestAvailableParityGroupCapacity

long

Free capacity of the parity group that has the largest available capacity or of external parity groups (KB)

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/storage-summaries/instance?detailInfoType=parityGroupCapacity