Getting information about the capacity of a storage system

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 the total capacity and the size of free space of all parity groups configured in the target storage system.
Important:

The size of free space (freeSpace) and the total capacity (totalCapacity) do not include the size of areas where, because of boundary limitations, volumes cannot be created. For this reason, after certain operations, such as those to create or delete volumes, the total capacity value might change. For details about volume capacity, see the Provisioning Guide for Open Systems, or the Provisioning Guide.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/total-capacities/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
None.
Body

None.

Response message

Body
{
  "internal": {
    "freeSpace": 30405195264,
    "totalCapacity": 34921689272
  },
  "external": {
    "freeSpace": 0,
    "totalCapacity": 142606336
  },
  "total": {
    "freeSpace": 30405195264,
    "totalCapacity": 35064295608
  }
}

Attribute

Type

Description

internal

object

An attribute related to the capacity of internal volumes is output.

  • freeSpace (long)

    The amount of free space in which users can create volumes (KB)

  • totalCapacity (long)

    The sums of the total capacity and the size of free space of all volumes created by the user (KB)

external

object

An attribute related to the capacity of external volumes is output.

If no external volumes are connected, the value 0 is output.

  • freeSpace (long)

    The amount of free space in which users can create volumes (KB)

  • totalCapacity (long)

    The sums of the total capacity and the size of free space of all volumes created by the user (KB)

total

object

An attribute related to the total capacity of internal volumes and external volumes is output.

  • freeSpace (long)

    The amount of free space in which users can create volumes (KB)

  • totalCapacity (long)

    The sums of the total capacity and the size of free space of all volumes created by the user (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/total-capacities/instance