Getting information about a specific volume

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request gets information about the volume for the specified volume ID.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/volumes/object-ID

Request message

Object ID

Specify the id value obtained by getting information about volumes.

Attribute

Type

Description

id

int

(Required) Volume ID

Query parameters
None.
Body
None.

Response message

Body

The following is an example of getting information about a volume with ID 100:

{
  "id": 100,
  "nickname": "JH-26216_DP",
  "poolId": 63,
  "poolName": "pool-1",
  "totalCapacity": 1024,
  "usedCapacity": 42,
  "freeCapacity": 982,
  "reservedCapacity": 0,
  "savingSetting": "COMPRESSION",
  "isDataReductionShareEnabled": true,
  "compressionAcceleration": true,
  "compressionAccelerationStatus": "ENABLED",
  "capacitySavingStatus": "Enabled",
  "numberOfConnectingServers": 2,
  "numberOfSnapshots": 0,
  "luns": [
    {
     "lun": 1,
     "serverId": 10,
     "portId": "CL1-A"
    },
    {
     "lun": 1,
     "serverId": 11,
     "portId": "CL2-A"
    }
  ],
  "volumeTypes": []
}

The obtained attributes include the following attributes, in addition to the attributes obtained when volume information is obtained:

Attribute

Type

Description

freeCapacity

long

Free space in the volume (MiB)

The total capacity of the volume appears when the volume is being created or deleted.

reservedCapacity

long

Capacity of the reserved pages in the volume (MiB)

compressionAccelerationStatus

string

Whether using compression acceleration with the capacity saving function is enabled for data in the volume

  • DISABLED: Capacity saving with compression acceleration is disabled.
  • ENABLED: Capacity saving with compression acceleration is enabled.
  • HYBRID: Volume contains both data for which capacity saving with compression acceleration is enabled and data for which capacity saving with compression acceleration is disabled.

This attribute appears if the storage system is a VSP E series storage system and the volume is a volume for which capacity saving is enabled or a deduplication system data volume (datastore).

capacitySavingProgress

int

Progress rate of the capacity saving (deduplication and compression) (%)

luns

object[]

Array of LUN configuration information:

  • lun (int):

    LU number

  • serverId (int):

    Server ID

  • portId (string):

    ID of the port to which the LUN is assigned

When volumeTypes is Namespace, this attribute does not appear.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/volumes/100