Getting pool 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 gets information items such as the pool status, the pool usage rate, and the pool threshold.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/pools

Request message

Object ID

None.

Query parameters

Query parameters can be specified to filter the execution results by the specified condition and also collect additional detailed information about pools.

  • When filtering execution results

    Parameter

    Type

    Filter Condition

    poolType

    string

    (Optional) The type of pools about which information will be obtained.

    The specifiable types are as follows:

    • DP: Information about DP pools is obtained.
    • HTI: Information about Thin Image pools is obtained.

    If this parameter is omitted, information about all pools will be obtained.

  • When collecting additional detailed information

    Parameter

    Type

    Description

    detailInfoType

    string

    (Optional) Type of detailed information to be obtained

    To specify multiple types, delimit the values by using commas.

    This parameter can be used in combination with the parameter to filter execution results.

    • FMC

      Detailed accelerated compression information of pools that consist of pool volumes belonging to the parity group of SSD(FMC) type drives is added.

    • tierPhysicalCapacity

      Additional detailed information about the physical capacity of the HDT pools in each tier is obtained.

      The obtained information is added to the tiers attribute in the response body that is displayed.

    • efficiency

      Additional detailed information is obtained about the saving efficiency for consumption of capacity (total efficiency) achieved by using the functions for increasing the usage efficiency of a pool (namely, the capacity saving function (dedupe and compression), the accelerated compression function, the creation of backup data by using snapshots, and the virtualization of capacity by using Dynamic Provisioning).

    • formattedCapacity

      Additional detailed information is obtained about the size of the formatted capacity of the pool.

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

    • autoAddPoolVol

      Information is added on whether a pool volume is added automatically, depending on the compression rate of the parity group for which accelerated compression is enabled.

    • tierDiskType

      The disk type is obtained for each tier.

      The obtained information is added to the tiers attribute in the response body that is displayed.

Body
None.

Response message

Body

The following is an example of the output generated when getting HDP pool information:

{
  "data" : [ {
    "poolId" : 5,
    "poolStatus" : "POLN",
    "usedCapacityRate" : 1,
    "usedPhysicalCapacityRate" : 1,
    "snapshotCount" : 0,
    "poolName" : "pool_5",
    "availableVolumeCapacity" : 32042850,
    "availablePhysicalVolumeCapacity" : 20006364,
    "totalPoolCapacity" : 32066496,
    "totalPhysicalCapacity" : 20009724,
    "numOfLdevs" : 11,
    "firstLdevId" : 2304,
    "warningThreshold" : 70,
    "depletionThreshold" : 80,
    "virtualVolumeCapacityRate" : -1,
    "isMainframe" : false,
    "isShrinking" : false,
    "locatedVolumeCount" : 13,
    "totalLocatedCapacity" : 79951368,
    "blockingMode" : "NB",
    "totalReservedCapacity" : 0,
    "reservedVolumeCount" : 0,
    "poolType" : "HDP",
    "duplicationLdevIds" : [ 65269, 65268, 65267, 65266, 65265, 65264, 65263, 65262 ],
    "duplicationNumber" : 8,
    "dataReductionAccelerateCompCapacity" : 206783585,
    "dataReductionCapacity" : 205901472,
    "dataReductionBeforeCapacity" : 210117216,
    "dataReductionAccelerateCompRate" : 87,
    "duplicationRate" : 42,
    "compressionRate" : 44,
    "dataReductionRate" : 97,
    "dataReductionAccelerateCompIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 228372480,
      "isReductionRateAvailable" : true,
      "reductionRate" : 97
    },
    "dataReductionIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 186826752,
      "isReductionRateAvailable" : true,
      "reductionRate" : 79
    },
    "snapshotUsedCapacity" : 0,
    "suspendSnapshot" : true,
    "capacitiesExcludingSystemData" : {
      "usedVirtualVolumeCapacity" : 235253760,
      "compressedCapacity" : 0,
      "dedupedCapacity" : 101035296,
      "reclaimedCapacity" : 129142560,
      "systemDataCapacity" : 43351104,
      "preUsedCapacity" : 234393600,
      "preCompressedCapacity" : 0,
      "preDedupredCapacity" : 105247408
    }
  } ]
}

For a DP pool:

Attribute

Type

Description

poolId

int

Object ID for the pool

poolName

string

Pool name

poolType

string

Pool type

  • HDP: HDP pool
  • HDT: HDT pool
  • RT: active flash pool
  • DM: Data Direct Mapping HDP pool

poolStatus

string

One of the following is output as the pool status:

  • POLN: Normal (Pool Normal)
  • POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
  • POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
  • POLE: The pool is suspended in the failure status. (Pool failure)

    If the pool status is POLE, pool information cannot be obtained.

usedCapacityRate

int

Usage rate of logical capacity (%)

usedPhysicalCapacityRate

int

Usage rate of physical capacity (%)

availableVolumeCapacity

long

Free logical capacity (MB)

availablePhysicalVolumeCapacity

long

Free physical capacity (MB)

For this attribute, 1 MB is equal to 1,0242 bytes.

totalPoolCapacity

long

Total logical capacity (MB)

totalPhysicalCapacity

long

Total physical capacity (MB)

For this attribute, 1 MB is equal to 1,0242 bytes.

numOfLdevs

int

Number of LDEVs in the pool

firstLdevId

int

The first LDEV number of the LDEVs in the pool

warningThreshold

int

The warning threshold set for the pool

depletionThreshold

int

The depletion threshold set for the pool

suspendSnapshot

boolean

Whether to suspend Thin Image pairs when the depletion threshold is exceeded

  • true: Thin Image pairs are suspended when the depletion threshold is exceeded.
  • false: Thin Image pairs are not suspended when the depletion threshold is exceeded.

virtualVolumeCapacityRate

int

The maximum subscription limit of a virtual volume relative to pool capacity

If unlimited is set, -1 is output.

For the following storage system models, -1 is output to indicate an invalid value: VSP G350, G370, G700, G900, VSP F350, F370, F700, F900.

isShrinking

boolean

Whether the pool is shrinking is output.

  • true: The pool is shrinking.
  • false: The pool is not shrinking.

locatedVolumeCount

int

Total number of DP volumes mapped to the pool

totalLocatedCapacity

long

Total capacity of the DP volumes mapped to the pool (MB)

The value of this attribute does not include the control area.

snapshotCount

int

Total number of snapshot data items mapped to the pool

snapshotUsedCapacity

long

Total size of snapshot data mapped to the pool (MB)

blockingMode

string

Setting the protection function for a virtual volume

When the DP pool is full or when the DP pool volume is blocked, whether the read and write operations can be performed for the DP volume that uses the target DP pool is output.

  • PF: Pool Full

    If the DP pool is full, read and write operations are not possible.

    If the DP pool volume is blocked, read and write operations are possible.

  • PB: Pool vol Blockade

    If the DP pool volume is blocked, read and write operations are not possible.

    If the DP pool is full, read and write operations are possible.

  • FB: Full or Blockade

    If the DP pool is full or the DP pool volume is blocked, read and write operations are not possible.

  • NB: No Blocking

    Even if the DP pool is full or the DP pool volume is blocked, read and write operations are possible for the target DP volume.

totalReservedCapacity

long

Total capacity of the reserved page (MB) of the DP volume that is related to the DP pool

If the Full Allocation functionality is not supported by the configuration, this attribute is not output.

reservedVolumeCount

int

Number of volumes associated with the DP pool for which the page reservation setting is enabled

If the Full Allocation functionality is not supported by the configuration, this attribute is not output.

poolActionMode

string

Execution mode for the pool

  • DEF: The mode in which the monitor is started or stopped by instructions from the REST API server, and the Tier range is specified by automatic calculation of the DKC.
  • AUT: The mode in which the monitor is started or stopped at the specified time, and the Tier range is specified by automatic calculation of the DKC (specified by using Storage Navigator).

monitoringMode

string

Performance monitoring execution mode (monitor mode)

  • PM: Period mode
  • CM: Continuous mode

tierOperationStatus

string

Operation status of performance monitoring and tier relocation is output.

  • STP: Performance monitoring and tier relocation are both stopped.
  • RLC: Performance monitoring is stopped and tier relocation is operating.
  • MON: Performance monitoring is operating and tier relocation is stopped.
  • RLM: Performance monitoring and tier relocation are both operating.

dat

string

Status of monitor information

  • VAL: Valid
  • INV: Invalid
  • PND: Pending calculation

tiers

object[]

The following attributes about HDT pool tiers are output for each tier.

  • tierNumber (int)

    Tier number

  • tierLevelRange (string)

    Lower limit of the tier

    The value is output as the number of I/O operations per hour (IOPH).

  • tierDeltaRange (string)

    Delta value for the tier

    The value is output as the number of I/O operations per hour (IOPH).

  • diskType (string)

    The disk type for each tier

    • SCM
    • SSD
    • SAS_7200
    • SAS_10000
    • SAS_15000
    • SATA_7200
    • EXTERNAL_LOW
    • EXTERNAL_MIDDLE
    • EXTERNAL_HIGH
    • MIXED

    This information is displayed if tierDiskType is specified for the detailInfoType query parameter when the request is executed.

  • tierUsedPhysicalCapacity (long)

    Physical capacity used by the tier (MB)

    This information is displayed if tierPhysicalCapacity is specified for the detailInfoType query parameter when the request is executed.

  • tierTotalPhysicalCapacity (long)

    Total physical capacity of the tier (MB)

    This information is displayed if tierPhysicalCapacity is specified for the detailInfoType query parameter when the request is executed.

  • tierUsedCapacity (long)

    Logical capacity used by the tier (MB)

  • tierTotalCapacity (long)

    Total logical capacity of the tier (MB)

  • tablespaceRate (int)

    Rate of free space to be used for new allocation

  • performanceRate (int)

    Performance utilization

  • progressOfReplacing (int)

    Relocation progress rate

    The progress rate of the following tier relocation operation is output as a value from 0 to 99.

    • When the value of the tierOperationStatus attribute is RLC or RLM: Progress rate of relocation (being run).
    • When the value of the tierOperationStatus attribute is STP or MON: Progress rate of relocation (being suspended).

    When tier relocation is not run or tier relocation is complete, 100 is output.

  • bufferRate (int)

    Buffer area rate for relocation

duplicationLdevIds

int[]

LDEV numbers of the deduplication system data volumes

duplicationNumber

int

Number of deduplication system data volumes

dataReductionAccelerateCompCapacity

long

Size (in blocks) of data reduction through the capacity saving function (dedupe and compression) or the accelerated compression function

The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.

dataReductionCapacity

long

Size (in blocks) of data reduction through the capacity saving function (compression and deduplication)

The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.

dataReductionBeforeCapacity

long

Size (in blocks) of data before data reduction was performed by using the capacity saving function (compression and deduplication)

dataReductionAccelerateCompRate

int

Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication) or the accelerated compression function

The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.

dataReductionRate

int

Percentage (%) of data on which data reduction has been performed by using the capacity saving function (compression and deduplication)

The size of data after reduction does not include the size of metadata and garbage data generated by the storage system.

dataReductionAccelerateCompIncludingSystemData

object

The attributes related to the size of data reduced by using the capacity saving function (compression and deduplication) or the accelerated compression function are displayed.

These attributes are calculated based on the size of the data (which includes, in addition to user data, metadata and garbage data generated by the storage system) after data reduction is performed.

  • isReductionCapacityAvailable (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 reductionCapacity 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).

  • reductionCapacity (long)

    Size (in blocks) of the data that was reduced

    This attribute is displayed when the value of the isReductionCapacityAvailable attribute is true.

  • isReductionRateAvailable (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 percentage by which the size of the data has been reduced is displayed for the reductionRate 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).

  • reductionRate (int)

    Percentage (%) by which the size of the data has been reduced

    This attribute is displayed when the value of the isReductionRateAvailable attribute is true.

dataReductionIncludingSystemData

object

The attributes related to the size of data reduced by using the capacity saving function (compression and deduplication) are displayed.

These attributes are calculated based on the size of the data (which includes, in addition to user data, metadata and garbage data generated by the storage system) after data reduction is performed.

  • isReductionCapacityAvailable (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 reductionCapacity 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).

  • reductionCapacity (long)

    Size (in blocks) of the data that was reduced

    This attribute is displayed when the value of the isReductionCapacityAvailable attribute is true.

  • isReductionRateAvailable (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 percentage by which the size of the data has been reduced is displayed for the reductionRate 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).

  • reductionRate (int)

    Percentage (%) by which the size of the data has been reduced

    This attribute is displayed when the value of the isReductionRateAvailable attribute is true.

capacitiesExcludingSystemData

object

Attributes related to the capacity saving achieved by using the capacity saving function (dedupe and compression) are displayed.

  • usedVirtualVolumeCapacity (long)

    The capacity (in blocks) used by virtual volumes

    This does not include the capacity used by the system data volume for the dedupe function.

  • compressedCapacity (long)

    The size (in blocks) of data reduced by using compression

    This does not include the size of metadata and garbage data generated by the storage system.

  • dedupedCapacity (long)

    The size (in blocks) of data reduced by using deduplication (dedupe)

    This does not include the size of metadata and garbage data generated by the storage system.

  • reclaimedCapacity (long)

    The size (in blocks) of data reduced by reclaiming the specified data pattern

    This does not include the size of metadata and garbage data generated by the storage system.

  • systemDataCapacity (long)

    The size (in blocks) of system data reduced

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

  • preUsedCapacity (long)

    The size (in blocks) of the data before data reduction was performed

  • preCompressedCapacity (long)

    The size (in blocks) of the data before compression was performed

  • preDedupredCapacity (long)

    The size (in blocks) of the data before dedupe was performed

compressionRate

int

Percentage (%) of data on which data reduction has been performed by using the compression function or the accelerated compression function

duplicationRate

int

Percentage (%) of data on which data reduction has been performed by using the deduplication function

isMainframe

boolean

Displays a pool for the mainframe or the open system

  • true: Pool for the mainframe volume
  • false: Pool for the open volume

The following is an example of the output generated when getting Thin Image pool information:

{
  "data": [ {
    "poolId" : 35,
    "poolStatus" : "POLN",
    "usedCapacityRate" : 1,
    "usedPhysicalCapacityRate" : 1,
    "snapshotCount" : 2,
    "poolName" : "pool_35",
    "availableVolumeCapacity" : 46704,
    "availablePhysicalVolumeCapacity" : 46704,
    "totalPoolCapacity" : 46998,
    "totalPhysicalCapacity" : 46998,
    "numOfLdevs" : 1,
    "firstLdevId" : 18952,
    "warningThreshold" : 80,
    "virtualVolumeCapacityRate" : -1,
    "isMainframe" : false,
    "isShrinking" : false,
    "poolType" : "HTI",
    "capacitiesExcludingSystemData" : {
      "usedVirtualVolumeCapacity" : 602112
    }
  } ]
}

For a Thin Image pool:

Attribute

Type

Description

poolId

int

Object ID for the pool

poolName

string

Pool name

poolType

string

Pool type is output.

HTI: Thin Image pool

poolStatus

string

One of the following is output as the pool status:

  • POLN: Normal (Pool Normal)
  • POLF: The pool is in the overflow status exceeding the threshold. (Pool Full)
  • POLS: The pool is in the overflow status exceeding the threshold and is suspended. (Pool Suspend)
  • POLE: The pool is suspended in the failure status. (Pool failure)

    If the pool status is POLE, pool information cannot be obtained.

usedCapacityRate

int

Usage rate of logical capacity (%)

usedPhysicalCapacityRate

int

Usage rate of physical capacity (%)

snapshotCount

int

Number of volumes in the pool

availableVolumeCapacity

long

Free logical capacity (MB)

availablePhysicalVolumeCapacity

long

Free physical capacity (MB)

For this attribute, 1 MB is equal to 1,0242 bytes.

totalPoolCapacity

long

Total logical capacity (MB)

totalPhysicalCapacity

long

Total physical capacity (MB)

For this attribute, 1 MB is equal to 1,0242 bytes.

numOfLdevs

int

Number of LDEVs in the pool

firstLdevId

int

The first LDEV number of the LDEVs in the pool

(Not the first number in ascending order)

warningThreshold

int

The warning threshold set for the pool

virtualVolumeCapacityRate

int

-1 indicating the invalid value is output.

isShrinking

boolean

Whether the pool is shrinking is output.

  • true: The pool is shrinking.
  • false: The pool is not shrinking.

isMainframe

boolean

Displays a pool for the mainframe or the open system

  • true: Pool for the mainframe volume
  • false: Pool for the open volume

capacitiesExcludingSystemData

object

Attributes related to the saving efficiency for consumption of capacity are displayed.

  • usedVirtualVolumeCapacity (long)

    The capacity (in blocks) used by virtual volumes

    This does not include the capacity used by the system data volume used for the dedupe function.

The following example shows the output when the detailed information for accelerated compression is obtained:

{
  "data" : [ {
    "poolId" : 40,
    "poolStatus" : "POLN",
    "usedCapacityRate" : 0,
    "usedPhysicalCapacityRate" : 0,
    "snapshotCount" : 0,
    "poolName" : "pool_40",
    "availableVolumeCapacity" : 46998,
    "availablePhysicalVolumeCapacity" : 46998,
    "usedPhysicalCapacity" : 0,
    "totalPoolCapacity" : 46998,
    "totalPhysicalCapacity" : 46998,
    "numOfLdevs" : 1,
    "firstLdevId" : 4095,
    "warningThreshold" : 70,
    "depletionThreshold" : 80,
    "virtualVolumeCapacityRate" : -1,
    "isMainframe" : false,
    "isShrinking" : false,
    "locatedVolumeCount" : 6,
    "totalLocatedCapacity" : 21672,
    "blockingMode" : "NB",
    "totalReservedCapacity" : 0,
    "reservedVolumeCount" : 0,
    "poolType" : "HDP",
    "duplicationNumber" : 0,
    "dataReductionAccelerateCompCapacity" : 0,
    "dataReductionCapacity" : 0,
    "dataReductionBeforeCapacity" : 0,
    "dataReductionAccelerateCompRate" : 0,
    "duplicationRate" : 0,
    "compressionRate" : 0,
    "dataReductionRate" : 0,
    "dataReductionAccelerateCompIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 0,
      "isReductionRateAvailable" : false
    },
    "dataReductionIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 0,
      "isReductionRateAvailable" : false
    },
    "snapshotUsedCapacity" : 0,
    "suspendSnapshot" : true,
    "availablePhysicalFMCPoolVolumesCapacity" : 46998,
    "usedPhysicalFMCPoolVolumesCapacity" : 4590,
    "availableFMCPoolVolumesCapacity" : 46998,
    "usedFMCPoolVolumesCapacity" : 46998,
    "fmcPoolVolumesCapacitySaving" : 42407,
    "fmcPoolVolumesCapacitySavingRate" : 90,
    "fmcPoolVolumesCapacityExpansionRate" : 100,
    "usedFMCLogicalPoolVolumesCapacity" : 0,
    "capacitiesExcludingSystemData" : {
      "usedVirtualVolumeCapacity" : 0,
      "compressedCapacity" : 0,
      "dedupedCapacity" : 0,
      "reclaimedCapacity" : 0,
      "systemDataCapacity" : 0,
      "preUsedCapacity" : 0,
      "preCompressedCapacity" : 0,
      "preDedupredCapacity" : 0
    }
  } ]
}

When the detailed information for accelerated compression is obtained:

When the drive type of the pool volumes that make up the pool is SSD(FMC), if you specify SSD(FMC) for the detailInfoType query parameter and then run the request, the following additional information is obtained.

Attribute

Type

Description

usedPhysicalCapacity

long

Total physical capacity usage (MB)

When the pool contains pool volumes for which the accelerated compression function is enabled, the compressed data is included in the total usage.

availablePhysicalFMCPoolVolumesCapacity

long

Total available physical capacity of pool volumes that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the total capacity reserved for writing in pool volumes that belong to a parity group and that support the accelerated compression function.

usedPhysicalFMCPoolVolumesCapacity

long

Physical capacity usage of pool volumes that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the used capacity after compression of the pool volumes that belong to a parity group and that support the accelerated compression function.

usedFMCLogicalPoolVolumesCapacity

long

Logical capacity usage of pool volumes that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the used capacity before compression of the pool volumes that belong to a parity group and that support the accelerated compression function.

availableFMCPoolVolumesCapacity

long

Total capacity of pool volumes that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the total capacity of the pool volumes that belong to a parity group and that support the accelerated compression function.

usedFMCPoolVolumesCapacity

long

Capacity usage of pool volumes that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the used capacity of the pool volumes that belong to a parity group and that support the accelerated compression function.

fmcPoolVolumesCapacitySaving

long

Amount of data reduction in the capacity of pool volumes and that support the accelerated compression function (MB)

From among the volumes making up a pool, this outputs the capacity reduced by compression of data in pool volumes that belong to a parity group and that support the accelerated compression function.

fmcPoolVolumesCapacitySavingRate

int

Rate of data reduction in the capacity of pool volumes that support the accelerated compression function (%)

From among the volumes making up a pool, this outputs the percentage (%) that fmcPoolVolumesCapacitySaving occupies of usedFMCPoolVolumesCapacity with regard to pool volumes that belong to a parity group and that support the accelerated compression function.

fmcPoolVolumesCapacityExpansionRate

int

Rate of capacity expansion of pool volumes that support the accelerated compression function (%)

This outputs the percentage (%) that availableFMCPoolVolumesCapacity occupies of availablePhysicalFMCPoolVolumesCapacity.

The following example shows the output when detailed information is obtained about the total efficiency.

{
  "data" : [ {
    "poolId" : 32,
    "poolStatus" : "POLN",
    "usedCapacityRate" : 49,
    "usedPhysicalCapacityRate" : 49,
    "snapshotCount" : 0,
    "poolName" : "pool_32",
    "availableVolumeCapacity" : 8190,
    "availablePhysicalVolumeCapacity" : 8190,
    "totalPoolCapacity" : 16254,
    "totalPhysicalCapacity" : 16254,
    "numOfLdevs" : 1,
    "firstLdevId" : 2229,
    "warningThreshold" : 70,
    "depletionThreshold" : 80,
    "virtualVolumeCapacityRate" : -1,
    "isMainframe" : false,
    "isShrinking" : false,
    "locatedVolumeCount" : 11,
    "totalLocatedCapacity" : 67173456,
    "blockingMode" : "NB",
    "totalReservedCapacity" : 0,
    "reservedVolumeCount" : 0,
    "poolType" : "HDP",
    "duplicationLdevIds" : [ 49098, 49097, 49096, 49095, 49094, 49093, 49092, 49091 ],
    "duplicationNumber" : 8,
    "dataReductionAccelerateCompCapacity" : 17174250,
    "dataReductionCapacity" : 17174250,
    "dataReductionBeforeCapacity" : 17175552,
    "dataReductionAccelerateCompRate" : 89,
    "duplicationRate" : 5,
    "compressionRate" : 84,
    "dataReductionRate" : 99,
    "dataReductionAccelerateCompIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 2580480,
      "isReductionRateAvailable" : true,
      "reductionRate" : 13
    },
    "dataReductionIncludingSystemData" : {
      "isReductionCapacityAvailable" : true,
      "reductionCapacity" : 2580480,
      "isReductionRateAvailable" : true,
      "reductionRate" : 14
    },
    "snapshotUsedCapacity" : 0,
    "suspendSnapshot" : true,
    "efficiency" : {
      "isCalculated" : true,
      "totalRatio" : "112.52",
      "compressionRatio" : "17.07",
      "snapshotRatio" : "-",
      "provisioningRate" : "84",
      "calculationStartTime" : "2016-07-31T20:32:47Z",
      "calculationEndTime" : "2016-07-31T20:41:09Z",
      "dedupeAndCompression" : {
        "totalRatio" : "18.47",
        "compressionRatio" : "8.61",
        "dedupeRatio" : "2.03",
        "reclaimRatio" : "1.05"
      },
      "acceleratedCompression" : {
        "totalRatio" : "1.00",
        "compressionRatio" : "1.00",
        "reclaimRatio" : "1.00"
      }
    },
    "capacitiesExcludingSystemData" : {
      "usedVirtualVolumeCapacity" : 19095552,
      "compressedCapacity" : 15975441,
      "dedupedCapacity" : 1064681,
      "reclaimedCapacity" : 1021936,
      "systemDataCapacity" : 15481578,
      "preUsedCapacity" : 18063360,
      "preCompressedCapacity" : 17041424,
      "preDedupredCapacity" : 1064982
    }
  } ]
}

When detailed information is obtained about the total efficiency

If you run the request with efficiency specified for the query parameter detailInfoType, the following information is obtained.

Attribute

Type

Description

efficiency

object

Attributes related to the total efficiency are displayed.

Calculated results for the period from calculationStartTime to calculationEndTime are obtained.

Only When true is specified for the attribute isCalculated, other subordinate attributes are also obtained. If the pool volume for which the calculation is to be performed does not exist, a hyphen (-) indicating an invalid value is displayed for these attributes. If the calculation cannot be performed for the pool because the pool is blocked or some other reason, the value from the previous calculation is displayed.

For the attributes that display the total efficiency or the efficiency of capacity saving, these results are displayed as a ratio of the size of data before reduction to the size of data after reduction, where the size of data after reduction is 1.

  • isCalculated (boolean)

    Calculation status of the total efficiency

    This attribute indicates whether the total efficiency has been calculated.

    • true: The values have been calculated.
    • false: The values have not been calculated.
  • calculationStartTime (ISO8601string)

    The date and time when the calculation of the total efficiency began (UTC)

    Displayed in the following format: YYYY-MM-DDThh:mm:ssZ

  • calculationEndTime (ISO8601string)

    The date and time when the calculation of the total efficiency ended (UTC)

    Displayed in the following format: YYYY-MM-DDThh:mm:ssZ

  • totalRatio (string)

    The total efficiency of the entire pool

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    After a volume is created from pool and before data is written to the volume, the maximum value (92233720368547758.07) is displayed.

  • compressionRatio (string)

    The efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) or accelerated compression

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

  • snapshotRatio (string)

    The efficiency of capacity saving performed by using snapshots to back up data

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

  • provisioningRate (string)

    The percentage (%) of the saving efficiency for consumption of capacity achieved by using Dynamic Provisioning to virtualize capacity

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

  • dedupeAndCompression (object)

    Attributes related to the efficiency of capacity saving performed by using the capacity saving function (dedupe and compression) are displayed.

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    • totalRatio (string)

      total efficiency of capacity saving performed by using the capacity saving function

    • compressionRatio (string)

      Efficiency of capacity saving performed by using compression

    • dedupeRatio (string)

      Efficiency of capacity saving performed by using deduplication (dedupe)

    • reclaimRatio (string)

      Efficiency of capacity saving performed by reclaiming the specified data pattern

  • acceleratedCompression (object)

    Attributes related to the efficiency of capacity saving performed by using accelerated compression are displayed.

    This does not include the size of metadata, garbage data, and other similar data generated by the storage system.

    • totalRatio (string)

      total efficiency of capacity saving performed by using accelerated compression

    • compressionRatio (string)

      Efficiency of capacity saving performed by using compression

    • reclaimRatio (string)

      Efficiency of capacity saving performed by reclaiming the specified data pattern

When detailed information is obtained about the formatted capacity of the pool

If you run the request with formattedCapacity specified for the query parameter detailInfoType, the following information is obtained.

Attribute

Type

Description

formattedCapacity

long

The formatted capacity of the pool (MB) is displayed.

If the information cannot be obtained, -1 is displayed, indicating an invalid value.

When additional detailed information is obtained from the storage system's cache

If you run this request with class specified for detailInfoType in the query parameters, the following information is obtained.

Immediately after an HDT pool is created, the information under the tiers attribute (shown in the following table) might not be output. In this case, wait a while and then run this request again. Alternatively, run the API request that updating the cache of storage system configuration information, and then run this request again.

Attribute

Type

Description

usedPhysicalCapacity

long

Used physical capacity (MB)

This information is output for DP pools.

tiers

object[]

The following attributes related to the tiers of an HDT pool are output for each tier.
  • raidLevel (string)

    RAID level

    • RAID1
    • RAID5
    • RAID6
    • Unknown

    Unknown is output if the RAID level is unknown or multiple RAID levels are being used.

  • raidType (string)

    The combination of data drives and parity drives in a RAID configuration

    • 2D+2D
    • 3D+1P
    • 4D+1P
    • 6D+1P
    • 6D+2P
    • 7D+1P
    • 12D+2P
    • 14D+2P
    • Unknown

    If any of the following apply, Unknown is output.

    • The combination of data drives and parity drives is unknown.
    • Multiple combinations of data drives and parity drives are being used.
    • Multiple RAID levels are being used.
  • driveSpeed (int)

    Drive speed (rpm)

    If any of the following apply, -1 is output:

    • The combination of data drives and parity drives is unknown.
    • Multiple combinations of data drives and parity drives are being used.
    • Multiple RAID levels are being used.

    This information is not output if driveTypeName is SSD or SCM.

  • driveTypeName (string)

    Drive types:

    • SAS
    • SSD
    • SCM
    • Unknown

    If any of the following apply, Unknown is output:

    • Multiple drive types are being used.
    • Multiple drives with different speeds are being used.
  • substance (string)

    Types of volumes that make up a tier:

    • Internal: Internal volume
    • External: External volume
    • Unknown: Unknown or a combination of internal and external volumes

hasBlockedPoolVolume

boolean

Whether a blocked pool volume exists

This information is output for DP pools, Thin Image pools.

  • true: A blocked pool volume exists
  • false: A blocked pool volume does not exist.

usedLocatedCapacityRate

int

Subscription rate of virtual volumes relative to the pool capacity (%)

This information is output for DP pools.

The ratio of the sum of DP volume capacities to the DP pool capacity is output.

The value is rounded down after the decimal point.

relocationInterval

int

Execution interval for performance monitoring and tier relocation

This information is output for HDT pools.

  • 0: 30 minutes
  • 1: 1 hour
  • 2: 2 hours
  • 4: 4 hours
  • 8: 8 hours
  • 24: 24 hours

monitoringStartTime

string

Start time for performance monitoring

This information is output for HDT pools.

If relocationInterval is anything other than 24, a hyphen (-) is output, indicating an invalid value.

monitoringEndTime

string

End time for performance monitoring

This information is output for HDT pools.

If relocationInterval is anything other than 24, a hyphen (-) is output, indicating an invalid value.

isExternalMixCompatibleEnabled

boolean

Whether a pool can be configured by using a combination of internal volumes and external volumes

This information is output for DP pools.

  • true: The pool can be configured by using a combination of internal and external volumes.
  • false: The pool cannot be configured by using a combination of internal and external volumes.

lastMonitoringStartTime

string

Date and time when performance monitoring started

This information is output for HDT pools.

This information is output in the format YYYY-MM-DDThh:mm:ss.

The local time of the storage system is output.

If the value is invalid, a hyphen (-) is output.

lastMonitoringEndTime

string

Date and time when performance monitoring ended

This information is output for HDT pools.

This information is output in the format YYYY-MM-DDThh:mm:ss.

The local time of the storage system is output.

If the value is invalid, a hyphen (-) is output.

relocationSpeed

string

The speed at which tiers are relocated

This information is output for HDT pools.

  • Slowest: Slowest
  • Slow: Slow
  • Normal: Normal
  • Fast: Fast
  • Fastest: Fastest

protectsLocatedVolumeOnFullPool

boolean

Whether DP volumes are protected when I/O to a DP volume fails because the pool has been depleted

This information is output for DP pools.

  • true: Protected
  • false: Not protected

protectsLocatedVolumeOnBlockedPoolVolume

boolean

Whether DP volumes are protected when I/O to a DP volume fails because the pool is blocked

This information is output for DP pools.

  • true: Protected
  • false: Not protected

isDeduplicationEnabled

boolean

Whether deduplication is enabled for the pool

This information is output for DP pools.

  • true: Enabled
  • false: Disabled

When detailed information is obtained on whether a pool volume is added automatically:

If you run the request with autoAddPoolVol specified for the query parameter detailInfoType, the following information is obtained.

Attribute

Type

Description

autoAddPoolVol

string

Displays information on whether a pool volume is added automatically, depending on the compression rate of the parity group for which accelerated compression is enabled.

  • Enabled: Added automatically
  • Disabled: Not added automatically
  • Not Supported: Not valid for this pool

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

When getting information about all pools:

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/pools

When getting information about DP pools:

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/pools?poolType=DP