Getting volume information

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 obtains information about multiple LDEVs. You can get information about consecutive LDEVs by specifying the number of the first LDEV and the number of LDEVs. You can also get information filtered by LDEV conditions (attributes) or resource group.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/ldevs

Request message

Object ID
None.
Query parameters

You can filter the execution result by specifying conditions, or request additional detailed volume information.

  • When filtering the execution result

    You can obtain information about 100 LDEVs by default, and information about 16,384 LDEVs by specifying the count parameter. If information about more than 16,384 LDEVs is obtained by specifying the ldevOption parameter or the poolId parameter, use the headLdevId parameter to obtain information about 16,385 or more LDEVs.

    Tip:

    Of the resources displayed by the filter, you can obtain information only about the resources for which you have been granted access permissions.

    For example, if you specify 10 for the count parameter and you have permission to access all LDEVs, information about 10 LDEVs will be obtained. If you have permission to access specific LDEVs only, information will be obtained only about LDEVs for which you have been granted access permissions.

    Important:

    For a VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900 storage system, pay attention to the number of concurrent executions of this API request. For details, see "Implementing retry processing".

    For details on query parameters that can be specified at the same time, see the following table showing the combinations of query parameters that can be specified.

    Parameter

    Type

    Filter Condition

    count

    int

    (Optional) Specify a value from 1 to 16384 for the number of LDEVs for which information is to be obtained.

    If this parameter is omitted, information about 100 LDEVs will be obtained.

    headLdevId

    int

    (Optional) Specify the number of the LDEV from which processing to get information is to start.

    The request gets information about the LDEVs in the ascending order of LDEV numbers, starting with the specified LDEV number.

    If this parameter is omitted, 0 is assumed.

    ldevOption

    string

    (Optional) LDEV conditions for getting information

    You can specify the following conditions:

    • defined

      Gets information about implemented LDEVs.

    • undefined

      Gets information about LDEVs that are not implemented.

    • dpVolume

      Gets information about DP volumes.

    • luMapped

      Gets information about LDEVs for which LU paths are defined.

    • luUnmapped

      Gets information about LDEVs for which LU paths are undefined.

    • externalVolume

      Gets information about external volumes.

    • mappedNamespace

      Gets information about the LDEV where the namespace is set.

      This value can be specified if the storage system is VSP 5000 series, VSP E1090, or VSP E1090H.

    If this is omitted, information about all types of LDEVs will be obtained.

    poolId

    int

    (Optional) Pool number

    Gets information about the LDEVs that are associated with the specified pool.

    By using the ldevOption parameter when specifying conditions, the following information will be obtained:

    • If dpVolume is specified for the ldevOption parameter:

      Gets information about the DP volumes that are associated with the specified pool.

    • If luMapped is specified for the ldevOption parameter:

      Gets information about LDEVs that are associated with the specified pool and that have one or more LU paths defined.

    • If luUnmapped is specified for the ldevOption parameter:

      Gets information about LDEVs that are associated with the specified pool and that do not have one or more LU paths defined.

    If you specify this parameter without specifying the ldevOption parameter, the processing gets information about the volumes that make up the pool (pool volumes).

    If defined or undefined is specified for the ldevOption parameter, you cannot specify this parameter.

    resourceGroupId

    int

    (Optional) ID of the resource group to which LDEVs for which information is to be obtained belong

    journalId

    int

    (Optional) ID of the journal to which LDEVs for which information is to be obtained belong

    parityGroupId

    string

    (Optional) ID of the parity group to which LDEVs for which information is to be obtained belong

    Specify concatenated parity groups in the same way as the above.

    If the concatenated parity groups are 1-3-1, 1-3-2, or 1-3-3, specify as follows:

    parityGroupId=1-3

    The following table shows the combinations of query parameters that can be specified.

    Parameter

    count

    head​Ldev​Id

    ldev​Option

    pool​Id

    resource​Group​Id

    journal​Id

    parity​Group​Id

    count

    --

    Y

    Y

    Y

    Y

    Y

    Y

    head​Ldev​Id

    Y

    --

    Y

    N

    N

    N

    N

    ldev​Option

    Y

    Y

    --

    Y#

    Y

    N

    N

    pool​Id

    Y

    N

    Y#

    --

    Y

    N

    N

    resource​Group​Id

    Y

    N

    Y

    Y

    --

    Y

    Y

    journal​Id

    Y

    N

    N

    N

    Y

    --

    N

    parity​Group​Id

    Y

    N

    N

    N

    Y

    N

    --

    #: If defined, undefined, or externalVolume is specified as the value of the ldevOption parameter, you cannot specify this parameter.

  • When requesting additional detailed information

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    You can use this parameter together with parameters that filter the execution results.

    The following values can be specified. To specify multiple values, separate the values by using commas.

    • FMC

      Adds detailed information about accelerated compression for the LDEVs that belong to parity groups with drive type SSD(FMC).

    • externalVolume

      Adds detailed information about external volumes.

    • virtualSerialNumber

      Adds detailed information about virtual storage machines.

    • savingInfo

      Adds detailed information about the capacity saving function (dedupe and compression).

    • 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".

      Immediately after you create an LDEV, if you specify class and at the same time specify defined in the query parameter ldevOption and then run the command, the volume status might be output as unimplemented. In such a case, wait a while and then run this request again. Alternatively, run the API request that updates the cache of storage system configuration information, and then run this request again.

    • qos

      Adds information about QoS settings.

    • nguId

      Adds the NGUID (Namespace Globally Unique Identifier).

      You can specify this value for VSP 5000 series, VSP E1090, VSP E1090H.

Query parameters can be specified as shown in the following examples.

  • The following example retrieves information about 30 LDEVs from LDEV number 1234:
    ?headLdevId=1234&count=30
  • The following example obtains information about 30 implemented LDEVs that belong to resource group number 5:
    ?ldevOption=defined&count=30&resourceGroupId=5
  • The following example obtains information about 30 DP volumes that are associated with pool number 7, out of the LDEVs that belong to resource group number 5:
    ?ldevOption=dpVolume&pool=7&count=30&resourceGroupId=5
  • The following example retrieves information about 30 LDEVs, for which detailed information about accelerated compression is added:
    ?detailInfoType=FMC&count=30
Body
None.

Response message

Body

For details on attributes to be obtained in the body of the response message, see the description of the API function for getting information about a specific volume.

{
  "data": [
    {
      "ldevId": 0,
      "clprId": 0,
      "emulationType": "OPEN-V-CVS",
      "byteFormatCapacity": "1.00 G",
      "blockCapacity": 2097152,
      "numOfPorts": 2,
      "ports": [
        {
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "1A-G00",
          "lun": 1
        },
        {
          "portId": "CL2-A",
          "hostGroupNumber": 0,
          "hostGroupName": "2A-G00",
          "lun": 1
        }
      ],
      "attributes": [
        "CVS",
        "HDP"
      ],
      "label": "JH-26216_DP",
      "status": "NML",
      "mpBladeId": 2,
      "ssid": "0012",
      "poolId": 63,
      "numOfUsedBlock": 86016,
      "isFullAllocationEnabled": false,
      "resourceGroupId": 0,
      "dataReductionStatus": "ENABLED",
      "dataReductionMode": "compression_deduplication",
      "dataReductionProcessMode" : "post_process",
      "isAluaEnabled": false
    },
    {
      "ldevId": 1,
      "clprId": 0,
      "emulationType": "OPEN-V-CVS",
      "byteFormatCapacity": "1.00 G",
      "blockCapacity": 2097152,
      "numOfPorts": 2,
      "ports": [
        {
          "portId": "CL1-A",
          "hostGroupNumber": 0,
          "hostGroupName": "1A-G00",
          "lun": 2
        },
        {
          "portId": "CL2-A",
          "hostGroupNumber": 0,
          "hostGroupName": "2A-G00",
          "lun": 2
        }
      ],
      "attributes": [
        "CVS",
        "HDP"
      ],
      "label": "JH-26216_DP",
      "status": "NML",
      "mpBladeId": 0,
      "ssid": "0012",
      "poolId": 63,
      "numOfUsedBlock": 0,
      "isFullAllocationEnabled": false,
      "resourceGroupId": 0,
      "dataReductionStatus": "DISABLED",
      "dataReductionMode": "disabled",
      "isAluaEnabled": false
    }
  ]
}

If the LDEV is not implemented:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

emulationType

string

NOT DEFINED (a value that indicates the LDEV is not implemented) is output.

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group to which LDEVs for which information is to be obtained belong

If the volume is an internal volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

composingPoolId

int

Pool ID of the pool that includes the LDEV

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volume
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy,TrueCopy for Mainframe, Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • T10PI: Volume for which the T10 PI attribute is enabled
  • RCMD: Remote command device
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

raidLevel

string

RAID level

raidType

string

Drive configuration

numOfParityGroups

int

Number of parity groups to which the LDEV belongs

parityGroupIds

string[]

Parity group to which the LDEV belongs

driveType

string

Code indicating the drive type of the drive belonging to the LDEV

driveByteFormatCapacity

string

Capacity of the drive belonging to the LDEV

The value is output to the second decimal place.

driveBlockCapacity

long

Number of blocks of the drive belonging to the LDEV

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group

isAluaEnabled

boolean

Whether the ALUA (Asymmetric Logical Unit Access) attribute is enabled

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

If the volume is an external volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

composingPoolId

int

Pool ID of the pool that includes the LDEV

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volumes
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy, TrueCopy for Mainframe, Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • MG: Volume used for data migration
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

resourceGroupId

int

ID of the resource group

externalVendorId

string

Vendor information in SCSI information for the external volume

externalProductId

string

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

externalVolumeId

string

Device identification information in SCSI information for the external volume (output in hexadecimal number format)

externalVolumeIdString

string

Device identification information in SCSI information for the external volume (output in ASCII format)

numOfExternalPorts

int

Number of alternate paths

externalPorts

object[]

For the defined alternate paths, the following attributes are output:

  • portId (string)

    Port number

  • hostGroupNumber (int)

    This attribute is currently not in use. 0 is always displayed for this attribute.

  • lun (int)

    LUN

  • wwn (string)

    WWN

quorumDiskId

int

ID of the Quorum disk

This attribute is output only if the external volume is a Quorum disk of the global-active device.

quorumStorageSerialNumber

string

Device number of the Quorum disk

This attribute is output only if the external volume is a Quorum disk of the global-active device.

quorumStorageTypeId

string

ID for identifying the Quorum disk device

This attribute is output only if the external volume is a Quorum disk of the global-active device.

R7: Virtual Storage Platform

R8: VSP G1000, VSP G1500, VSP F1500

R9: VSP 5000 series

M7: HUS VM

M8: VSP E series, VSP Gx00 models, VSP Fx00 models

isAluaEnabled

boolean

Whether the ALUA attribute is enabled:

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

If the volume is a virtual volume:

Attribute

Type

Description

ldevId

int

LDEV number

virtualLdevId

int

Virtual LDEV number

If the virtual LDEV number is not set, 65534 (FF:FE) is output.

If the reserved attribute of global-active device is set, 65535 (FF:FF) is output.

clprId

int

CLPR number

emulationType

string

The LDEV emulation type or the LDEV status information is output by using one of the following values:

  • NOT DEFINED: The LDEV is not implemented.
  • DEFINING: The LDEV is being created.
  • REMOVING: The LDEV is being removed.

byteFormatCapacity

string

Capacity of the LDEV

The value is output to the second decimal place.

blockCapacity

long

Number of blocks of the LDEV

numOfPorts

int

Number of ports for which a path to the LDEV is defined

If a namespace is set for the LDEV, 0 is output.

ports

object[]

For ports for which a path to the LDEV is defined, the following attributes are output.

If a namespace is set for the LDEV, this attribute is not output.

  • portId (string)

    Port number

  • hostGroupNumber (int)

    Host group number

  • hostGroupName (string)

    Host group name

    This request can obtain host group names that are no more than 16 characters. To obtain a host group name that exceeds 16 characters, run the API function for getting information about the host group or the iSCSI target.

  • lun (int)

    LUN

attributes

string[]

LDEV attributes

The following attributes are output:

  • CMD: Command device (except for command devices for mainframes)
  • CLUN: Cache LUN (DCR)
  • CVS: CVS volume
  • ALUN: Volume Migration volume
  • ELUN: External volume
  • OLG: OpenLDEV Guard volume
  • VVOL: Virtual volume
  • HORC: Pair volume (P-VOL or S-VOL) for remote copy (TrueCopy, TrueCopy for Mainframe , Universal Replicator, Universal Replicator for Mainframe)
  • MRCF: ShadowImage volume (P-VOL or S-VOL)
  • HTI: Thin Image volume (P-VOL or S-VOL)
  • JNL: Journal volume
  • HDP: HDP volume or Dynamic Provisioning for Mainframe volume
  • HDT: HDT volume
  • POOL: Pool volume
  • QRD: Quorum disk
  • ENCD: Encrypted disk
  • SYSD: System disk
  • TSE: HDP volume used for FCSE
  • GAD: global-active device volume
  • DSD: Deduplication system data volume (fingerprint)
  • DS: Deduplication system data volume (data store)
  • MG: Volume used for data migration
  • ESE: Virtual volume capable of page release by the User Directed Space Release function

label

string

Label of the LDEV

status

string

Status of the LDEV

  • NML: The LDEV is in normal status.
  • BLK: The LDEV is blocked.
  • BSY: The LDEV status is being changed.
  • Unknown: The LDEV status is unknown (not supported).

operationType

string

The operation in progress:

  • FMT: Formatting is in progress.
  • QFMT: Quick formatting is in progress.
  • CCOPY: Collection copying is in progress.
  • CACCS: Collection access is in progress.
  • SHRD: Shredding is in progress.
  • ZPD: Pages are being released.
  • SHRPL: Deletion from the pool is in progress.
  • RLC: Pools are being reallocated.
  • RBL: Pools are being rebalanced.

preparingOperationProgressRate

int

Progress of formatting or shredding

For cases other than above, 100 is output.

mpBladeId

int

MP blade ID

ssid

string

SSID

This attribute is output only if an SSID has been set.

poolId

int

ID of the pool with which the LDEV is associated

  • For DP volumes: ID of the associated DP pool
  • For virtual volumes for Thin Image: ID of the pool in which the snapshot data was created

numOfUsedBlock

long

Number of blocks used in the pool.

This includes the number of blocks whose pages are reserved by the Full Allocation functionality.

resourceGroupId

int

ID of the resource group

snapshotPoolId

int

ID of the pool in which the snapshot data was created

This attribute is output when the LDEV is both an S-VOL of a Thin Image pair and an HDP volume.

isRelocationEnabled

boolean

Status of relocation

  • true: Relocation is enabled.
  • false: Relocation is stopped.

tierLevel

string

Tiering policy used for relocation

  • all: All tiers are used for relocation (level 0)
  • 1 to 5: Relocation is performed by following the tiering policy (levels 1 to 5)
  • 6 to 31: Relocation is performed by following the tiering policy (custom policy)

usedCapacityPerTierLevel1

long

Capacity allocated to tier 1 (in MB)

usedCapacityPerTierLevel2

long

Capacity allocated to tier 2 (in MB)

usedCapacityPerTierLevel3

long

Capacity allocated to tier 3 (in MB)

tierLevelForNewPageAllocation

string

New page assignment tier

  • H: The page is allocated to a higher-level tier (High)
  • M: The page is allocated to a middle-level tier (Middle)
  • L: The page is allocated to a lower-level tier (Low)

tier1AllocationRateMin

int

Minimum capacity of tier 1 of the set tiering policy

tier1AllocationRateMax

int

Maximum capacity of tier 1 of the set tiering policy

tier3AllocationRateMin

int

Minimum capacity of tier 3 of the set tiering policy

tier3AllocationRateMax

int

Maximum capacity of tier 3 of the set tiering policy

fullAllocationCapacity

long

Capacity for which pages are reserved by the Full Allocation functionality (in MB)

isFullAllocationEnabled

boolean

Whether pages are reserved by the Full Allocation functionality

  • true: The page reservation setting is enabled.
  • false: The page reservation setting is disabled.

dataReductionMode

string

Setting of the capacity saving function (dedupe and compression)
  • compression: The capacity saving function (compression) is enabled.
  • compression_deduplication: The capacity saving function (compression and deduplication) is enabled.
  • disabled: The capacity saving function (compression and deduplication) is disabled.

dataReductionProcessMode

string

Capacity-saving mode

  • post_process: Post-process mode
  • inline: Inline mode

This attribute is displayed for volumes for which the capacity saving function is enabled.

isCompressionAccelerationEnabled

boolean

Whether the compression accelerator of the capacity saving function (dedupe and compression) is enabled#1

  • true: Enabled
  • false: Disabled

This attribute is displayed for volumes for which the capacity saving function is enabled and that are in a storage system for which a compression accelerator is enabled.

dataReductionStatus

string

Status of the capacity saving function
  • ENABLED: The capacity saving function is enabled.
  • DISABLED: The capacity saving function is disabled.
  • ENABLING: The capacity saving function is being enabled.
  • REHYDRATING: The capacity saving function is being disabled.
  • DELETING: The volumes for which the capacity saving function is enabled are being deleted.
  • CONVERTING: The capacity saving function that uses a compression accelerator is being enabled or disabled.#1
  • FAILED: An attempt to enable the capacity saving function failed.

dataReductionProgressRate

int

Progress rate of the capacity saving function (%)

This attribute is output when one of the following is output for the dataReductionStatus attribute.

ENABLING, REHYDRATING, DELETING, CONVERTING#1

compressionAccelerationStatus

string

Status of the capacity saving function that uses a compression accelerator#1

  • ENABLED: The capacity saving function that uses a compression accelerator is enabled.
  • DISABLED: The capacity saving function that uses a compression accelerator is disabled.
  • HYBRID#2: The volume contains both data for which the capacity saving function that uses a compression accelerator is enabled and data for which the capacity saving function that uses a compression accelerator is disabled.

    HYBRID is displayed for the dataReductionStatus attribute even if the status is CONVERTING.

This attribute is displayed for volumes for which the capacity saving function is enabled and that are in a storage system for which a compression accelerator is enabled.

isAluaEnabled

boolean

Whether the ALUA attribute is enabled:

  • true: The ALUA attribute is enabled.
  • false: The ALUA attribute is disabled.

namespaceId

string

Namespace ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and a namespace is set for the LDEV.

nvmSubsystemId

string

NVM subsystem ID

This attribute is output if the storage system is a VSP 5000 series, VSP E1090, VSP E1090H storage system and an NVM subsystem is set for the LDEV.

#1 If you enabled the capacity saving function that uses a compression accelerator by running the API request to change volume settings, check whether the settings have been changed successfully based on the following attributes.
  • The dataReductionStatus attribute: If the value is CONVERTING, the capacity saving function that uses a compression accelerator is being enabled or disabled.
  • The isCompressionAccelerationEnabled attribute: If the value is true, the setting is being changed from disabled to enabled.
If the values of these attributes are as follows, this indicates that the capacity saving function that uses a compression accelerator has been enabled.
  • dataReductionStatus: ENABLED
  • isCompressionAccelerationEnabled: true
If the capacity saving function that uses a compression accelerator setting does not change, perform the following steps:
  • If the value of the dataReductionStatus attribute does not change to CONVERTING, the relevant volume or hardware is not in a state where the setting can be changed. Check whether the volume or hardware is in a state where the setting can be changed by referring to the Provisioning Guide for Open Systems, or the Provisioning Guide.
  • If the value of the dataReductionStatus attribute is CONVERTING and the value of the dataReductionProgressRate attribute (the progress rate) does not change, a compression accelerator might be blocked. Use the API request for acquiring a list of alert information to check whether a compression accelerator is blocked. If it is not blocked, refer to the troubleshooting section of the Provisioning Guide for Open Systems, or the Provisioning Guide.

#2 Of the volumes in a pool, if the capacity saving function that uses a compression accelerator is enabled for even one volume for which deduplication is enabled, the capacity saving function that uses a compression accelerator will be enabled for the duplicate data in that pool. For this reason, for a volume for which the capacity saving function that uses a compression accelerator is disabled, the capacity saving function that uses a compression accelerator will be enabled for some data in the volume and disabled for other data in the volume, depending on whether the data is duplicated. As a result, the value of the compressionAccelerationStatus attribute is HYBRID.

If the volume is a Thin Image P-VOL:

In addition to the attributes output if the volume is an internal volume, the following attribute is obtained.

Attribute

Type

Description

usedCapacityForSnapshot

long

Capacity used for snapshots in a Thin Image P-VOL (in MB)

The snapshot capacity that is allocated from the pool and used as data is output.

For the root volume of a snapshot tree, the snapshot capacity of the root volume is output.

usedTotalCapacityForSnapshot

long

Capacity of all snapshots that are allocated from the pool used by the root volume (in MB)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used.

This value includes the volume of metadata and garbage data generated by the storage system.

garbageDataCapacityForSnapshot

long

Volume of snapshot garbage data (in MB)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used, if the processing to delete snapshot garbage data is not in progress.

If the volume is less than 1 MB, this value is rounded up.

deletingGarbageDataStatusForSnapshot

string

Deletion status of snapshot garbage data

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used.

  • PROCESSING: The deletion processing is in progress
  • STOPPING: The deletion process is stopped
  • NONE: The deletion processing is not in progress

deletingGarbageDataProgressRateForSnapshot

int

Progress of the processing for deleting snapshot garbage data (%)

This attribute is output for VSP 5000 series.

This attribute is output when a Thin Image root volume is used, if snapshot garbage data is in the process of being deleted.

If the drive type of the parity group to which the volumes belong is SSD(FMC):

Specify FMC for the detailInfoType query parameter, and then run the request to obtain additional detailed information for accelerated compression.

{
  "data": [
    {
      "ldevId": 280,
      ...
      ...
      "isExpandedSpaceUsed": true
    }
  ]
}

Attribute

Type

Description

isExpandedSpaceUsed

boolean

Indicates whether the LDEV uses the expanded area.

  • true: The LDEV uses the expanded area.
  • false:The LDEV uses the physical area.

If the volume is an external volume:

Specify externalVolume for the detailInfoType query parameter, and then run the request to obtain additional detailed information for the external volume.

Attribute

Type

Description

externalStorageSerialNumber

string

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

If you execute the request with virtualSerialNumber specified for the detailInfoType query parameter, the request also obtains detailed information about the virtual storage machines.

Attribute

Type

Description

virtualSerialNumber

string

Serial number of the virtual storage machine

virtualModel#

string

Model name of the virtual storage machine

virtualModelDetail#

string

Detailed model name of the virtual storage machine

This attribute is output if the virtual storage machine is in the VSP 5000 series.

#: For virtual storage machines in the VSP 5000 series, the series name VSP 5000 series AFA or VSP 5000 series hybrid is output for the virtualModel attribute, and VSP 5100, 5500, VSP 5200, 5600, VSP 5100H, 5500H, or VSP 5200H, 5600H is output for the virtualModelDetail attribute.

If you run the request with savingInfo specified for the detailInfoType query parameter, the request also obtains detailed information about the capacity saving function for the volumes for which the capacity saving function is enabled.

{
  "data": [
    {
      "ldevId": 12,
      ...
      ...
      "dataReductionTotalSavingRatio": "2.44",
      "isDataReductionTotalSavingBlockAvailable": true,
      "dataReductionTotalSavingBlock": 13878844,
      "dataReductionSavingBlockCompression": 12134812,
      "dataReductionSavingBlockDeduplication": 808078,
      "dataReductionSavingBlockReclaim": 1076144,
      "dataReductionSystemBlock": 140190,
      "dataReductionPreUsedBlock": 23489911,
      "dataReductionPoolBlock": 9611067
    }
  ]

Attribute

Type

Description

dataReductionTotalSavingRatio

string

The ratio of volume capacity reduced by using the capacity reduction function

The capacity before data reduction is displayed as a ratio of the capacity after data reduction, where the capacity after data reduction is assigned a value of 1.

isDataReductionTotalSavingBlockAvailable

boolean

Whether the size of the data can be reduced

  • true : The size of the data can be reduced.

    If the value of this attribute is true, the size of the data that has been reduced is displayed for the dataReductionTotalSavingBlock attribute.

  • false : The size of the data cannot be reduced (for example, if the size of the data after data reduction is greater than the size of the data before data reduction).

dataReductionTotalSavingBlock

long

Total number of blocks reduced by using the capacity saving function

This value is displayed when the isDataReductionTotalSavingBlockAvailable attribute is set to true.

This value includes the amount of zero data that was reduced and the volume of metadata and garbage data generated by the storage system.

dataReductionSavingBlockCompression

long

Number of blocks reduced by using the capacity saving function (compression)

The value does not include the volume of metadata and garbage data generated by the storage system.

dataReductionSavingBlockDeduplication

long

Number of blocks reduced by using the capacity saving function (deduplication)

The value does not include the volume of metadata and garbage data generated by the storage system.

dataReductionSavingBlockReclaim

long

Number of blocks reduced by using the capacity saving function (reclaiming of the specified data pattern)

The value does not include the volume of metadata and garbage data generated by the storage system.

dataReductionSystemBlock

long

Total number of blocks of system data (metadata and garbage data) used by the capacity saving function

The value does not include the volume of metadata and garbage data in the deduplication system data volumes.

dataReductionPreUsedBlock

long

Number of blocks before data reduction

dataReductionPoolBlock

long

Number of blocks in the pool volume used by the volume

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

isDataDirectMapping

boolean

Whether the data direct mapping attribute is enabled

  • true: Enabled
  • false: Disabled

dataDirectMappingLdevId

int

LDEV number of the volume mapped by using data direct mapping

This information is output if a volume exists that is mapped by using data direct mapping.

This information is output when the value of the isDataDirectMapping attribute is true.

  • If the volume is an HDP volume: LDEV number of the pool volume
  • If the volume is a pool volume: LDEV number of the HDP volume

If no volume mapped by using data direct mapping exists, -1 is output, indicating an invalid value.

slotSize

long

Slot size (KB)

cacheResidencyMode

string

Cache residency mode

Unknown is always output.

readOnly

boolean

This attribute is currently not in use. false is always output.

usedCapacity

long

Used capacity of the DP volume (KB)

This information is output if the volume is a DP volume.

The used capacity that is output includes the capacity for which pages are reserved.

relocationPriority

string

Relocation priority

This information is output if the volume is an HDT volume.

  • Default: No priority is set.
  • Prioritized: Data is relocated preferentially when tier relocation is performed.

conglomerateLunDevice

string

Whether the volume is an ALU or an SLU

  • ALU
  • SLU
  • Unknown: Status unknown (unsupported)

commandDevice

object

Attributes related to the command device

This information is output when the volume is used as a command device.

  • isSecurityEnabled (boolean)

    Whether the security setting for the command device is enabled

    • true: Enabled
    • false: Disabled
  • isUserAuthenticationEnabled (boolean)

    Whether the user authentication setting for the command device is enabled

    • true: Enabled
    • false: Disabled
  • isDeviceGroupDefinitionEnabled (boolean)

    Whether the device group information authentication setting for the command device is enabled

    • true: Enabled
    • false: Disabled

externalDriveTypeName

string

Drive type of the external volume

  • SAS
  • SATA
  • BD
  • SSD
  • SCM
  • Unknown: Status unknown (unsupported)

If the information cannot be obtained, Unknown is output.

guardStatuses

string[]

Attribute related to access to the volume

  • Read/Write: The volume can be read and written to from all hosts.
  • Read Only: The volume can be read, but cannot be written to, from all hosts.
  • Protect: The volume cannot be read or written to from any host.
  • S-VOL Disable: Access to the secondary volume is not permitted.
  • Invisible: Invisible mode (Access via a SCSI command is not permitted.)
  • Zero Read Capacity: Zero Read Capacity mode (0 is returned as the response to a SCSI command.)
  • Unknown: Status unknown

If you run this request with qos specified for detailInfoType in the query parameters, information about QoS settings is also obtained.

Attribute

Type

Description

qos

object

Information about QoS settings

If QoS settings are configured, the following information is output.

  • upperIops (long)

    Upper limit on the IOPS

  • upperTransferRate (int)

    Upper limit on the amount of data that can be transferred per second (in MB)

  • upperAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second exceeds the upper limit for a continuous period of time (in seconds)

  • upperAlertTime (ISO8601string)

    Time when the last alert was issued because the IOPS or the amount of data transferred per second had exceeded the upper limit for a continuous period of time (UTC)

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

  • lowerIops (long)

    Lower limit on the IOPS

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerTransferRate (int)

    Lower limit on the amount of data that can be transferred per second (in MB)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the IOPS or the amount of data transferred per second falls below the lower limit for a continuous period of time (in seconds)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • lowerAlertTime (ISO8601string)

    Time when the last alert was issued because the IOPS or the amount of data transferred per second had fallen below the lower limit for a continuous period of time

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responsePriority (int)

    Priority level of the I/O processing

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • targetResponseTime (int)

    Target response time (in milliseconds) based on the priority level (responsePriority)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responseAlertAllowableTime (int)

    Amount of time to wait before issuing an alert when the response time exceeds the target response time for a continuous period of time (in seconds)

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

  • responseAlertTime (ISO8601string)

    Time when the last alert was issued because the response time had exceeded the target response time for a continuous period of time (UTC)

    This parameter is output in the format YYYY-MM-DDThh:mm:ssZ.

    This parameter is output if the storage system is VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

If you run this request with nguId specified for detailInfoType in the query parameters, information about NGUID settings is also obtained.

Attribute

Type

Description

nguId

string

Namespace identifier information

This attribute is not output if the namespace is not set.

If the namespace is set but the NGUID cannot be obtained, Unknown is output.

Status codes

For details on the status codes for the request of this operation, see the section explaining 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/ldevs?headLdevId=0&count=2"