Obtaining Volume Information

GET /volume/{volume_id}

Introduction

Obtains information for the specified Volume.

Request Examples

This is an example of obtaining the Status of a Volume ID 250003:

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/volume/250003?fields=status"

Response Examples

{
  "volume_id": 100001,
  "number": 1,
  "volume_href": "/api/v1/volume/100001",
  "name": "sample_vol#0",
  "status": "Normal",
  "detail_status": "Available",
  "type": "Standard",
  "allocated_resource_href": "/api/v1/tpp/0",
  "capacity": 10240,
  "usage": "Block",
  "uid": "600000e00d3100000031000000140000",
  "uid_mode": "Default",
  "is_format_in_progress": true,
  "is_exc_enabled": true,
  "is_cm_encryption_enabled": false,
  "is_sed_encryption_enabled": false,
  "is_copy_protection_enabled": true,
  "is_used_status_attention": false,
  "is_deduplication_enabled": true,
  "is_compression_enabled": true,
  "is_thick_provisioned": true,
  "used_capacity": 1024,
  "used_rate": 33,
  "original_data_size": 2023,
  "attention": 80,
  "balancing_level": "High",
  "is_t10dif_enabled": false,
  "alua": "Follow_Host_Response"
}

Parameters

PATH PARAMETERS

volume_id

(required)

integer

Volume ID.

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

volume_id

integer

Volume ID.

number

integer

Volume Number.

This is the Volume identifier used in ETERNUS Web GUI or ETERNUS CLI.

volume_href

string

Link to Volume Resource.

name

string

A Volume Friendly Name.

status

string

Status.

Item	Description
Normal	Normal state.
Maintenance	Maintenance state.
Warning	Preventive maintenance is required.
Error	An error has occurred and maintenance is required.

detail_status

string

Detailed status of the volume.

Item	Description
Available	Normal state.
Spare_In_Use	The RAID group maintains redundancy by using a Hot Spare Drive.
Readying	Unformatted state.
Rebuild	Rebuild is in progress from the failed Drive to the Hot Spare Drive or the replaced Drive.
Copyback	The information saved in the Hot Spare Drive is being written back to the replaced Drive.
Redundant_Copy	Redundant Copy state to Hot Spare Drive.
Partially_Exposed_Rebuild	Rebuild is in progress from the failed Drive to the Hot Spare Drive or the replaced Drive (Only for RAID 6 or RAID 6 FR).
Exposed_Rebuild	Two drives have failed and a rebuild is in progress from the first failed Drive to the Hot Spare Drive or the replaced Drive (Only for RAID 6 or RAID 6 FR).
Exposed	Redundancy has been lost due to a Drive failure.
Partially_Exposed	One drive has failed (Only for RAID 6 or RAID 6 FR).
Not_Ready	RAID is blocked state.
Broken	Failed state.
Data_Lost	Data is lost. Data cannot be read or written.

type

string

Volume Type.

Item	Description
Standard	A Volume that is created in a RAID Group or External RAID Group.
TPV	Thin Provisioning Volume. A Volume that is created in the Thin Provisioning Pool.
FTV	Flexible Tier Volume. A Volume that is created in the Thin Provisioning Pool. This volume type is a target for Automated Storage Tiering.
WSV	Wide Striping Volume. A Volume that distributes Data across RAID Groups.
SDV	Snap Data Volume. A Volume that can be used as a SnapOPC or SnapOPC+ copy destination.
SDPV	Snap Data Pool Volume. The Volumes that make up the Snap Data Pool.
Temporary	A temporary, working volume. Created only when you expand the capacity of a Standard Volume.

allocated_resource_href

string

Link to the Resource to which the Volume belongs.

The Link to the Thin Provisioning Pool is returned if Type is TPV.

The Link to the Flexible Tier Pool is returned if Type is FTV.

Otherwise, the Link to the RAID Group is returned.

allocated_resource_name

string

Name of the Resource to which the Volume belongs.

The name of the Thin Provisioning Pool is returned if Type is TPV.

The name of the Flexible Tier Pool is returned if Type is FTV.

Otherwise, the name of the RAID Group is returned.

capacity

integer

Volume capacity.

The unit is MB.

usage

string

The purpose of the volume.

Item	Description
Block	Volume used in the SAN.
System	Volume used for internal control.
Migration	Volume in use by Non-disruptive Storage Migration.
VVOL	The volume used by Virtual Volume.
Veeam	Volume used by Veeam Storage Integration.
ODX	Volume used with Offloaded Data Transfer.

uid

string

The Universal Identifier (UID) for the Volume.

An identifier (Device Name) to identify the Volume from the Server.

uid_mode

string

The state of the UID.

Item	Description
Default	The Default UID is set when the Volume is created.
Custom	The UID has changed since the Volume was created.
External	Volume information has been taken over from the source Volume due to Non-disruptive Storage Migration.

is_format_in_progress

boolean

Whether Format is running.

If true, Format is running.

is_exc_enabled

boolean

Indicates whether the volume is a target of Extreme Cache Pool.

If true, it is a target of Extreme Cache Pool.

is_cm_encryption_enabled

boolean

Whether the Volume is encrypted by the CM.

If true, the data in the Volume is encrypted by the CM.

is_sed_encryption_enabled

boolean

Indicates whether the Volume is encrypted by the SEDs.

If true, the data in the Volume is encrypted by the SEDs.

is_copy_protection_enabled

boolean

Whether the copy operation is protected.

If true, the volume cannot be used as a copy destination volume.

is_used_status_attention

boolean

Whether the Used Rate of the Volume exceeds the threshold (attention).

If true, the Used Rate is above the threshold.

is_deduplication_enabled

boolean

Whether Deduplication is enabled.

If true, data written to the Volume is deduplicated.

is_compression_enabled

boolean

Whether Compression is enabled.

If true, data written to the Volume is compressed.

is_thick_provisioned

boolean

Whether the allocation method is Thick.

If true, the volume was allocated physical space for use as capacity when created.

This item is returned if Type is "TPV" or "FTV".

used_capacity

integer

Volume's physically allocated capacity.

The unit is MB.

This item is returned if Type is "TPV" or "FTV".

However, it is not returned if the volume is a target of Data Reduction (Deduplication and/or Compression).

used_rate

integer

Volume utilization.

The unit is %.

This item is returned if Type is "TPV" or "FTV".

However, if information acquisition fails due to a device error, 0 may be returned.

original_data_size

integer

The amount of data written to the Volume.

If the Volume is a target of Data Reduction, this indicates the amount of data before reduction.

For non-Data Reduction volumes, this item matches with used_capacity.

This item is returned only if Type is "TPV" or "FTV".

However, it is not respond if the Volume is used as a System Volume.

If information acquisition fails due to a device error, 0 may be returned.

attention

integer

The Used Rate threshold at which the host sense is reported.

The unit is %.

This item is returned only if Type is "TPV" or "FTV".

However, it is not returned for Data Container Volumes.

balancing_level

string

The degree to which the physical quotas of the RAID Groups that make up the Thin Provisioning Pool are balanced.

This item is returned only if Type is "TPV".

Item	Description
High	Physical allocation is equal.
Medium	There is a slight bias in the physical allocation.
Low	There is a large bias in the physical allocation.

is_t10dif_enabled

boolean

Volume data protection format.

If true, T10-DIF compliant data protection is enabled.

alua

string

ALUA (Asymmetric Logical Unit Access) setting.

This item is not returned if a Mapping cannot be created for the Volume (Usage is System, or Type is VVOL, ODX Volume, SDPV, or Temporary Volume).

Item	Description
Follow_Host_Response	Follow the Host Response settings.
ACTIVE_ACTIVE	ACTIVE/ACTIVE response.
ACTIVE-ACTIVE_PREFERRED_PATH	ACTIVE-ACTIVE/PREFERRED PATH response.

is_connected

boolean

Whether the Volume is connected to a Host.

If true, a Host is connected to the Volume (this item is true when the Volume belongs to a LUN Group).

If false, no Hosts are connected to the Volume (this item is false when the Volume does not belong to a LUN Group).