Getting information about a specific pool

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/pools/object-ID

Request message

Object ID

Specify the poolId value obtained by getting information about the pools.

Attribute	Type	Description
poolId	int	(Required) Pool number

Query parameters

None.

Body

None.

Response message

Body

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

{
    "poolId": 0,
    "poolStatus": "POLN",
    "usedCapacityRate": 14,
    "usedPhysicalCapacityRate": 14,
    "snapshotCount": 0,
    "poolName": "testpool",
    "availableVolumeCapacity": 40320,
    "availablePhysicalVolumeCapacity": 40320,
    "totalPoolCapacity": 46998,
    "totalPhysicalCapacity": 46998,
    "numOfLdevs": 1,
    "firstLdevId": 1,
    "warningThreshold": 70,
    "depletionThreshold": 80,
    "virtualVolumeCapacityRate": -1,
    "isMainframe": false,
    "isShrinking": false,
    "locatedVolumeCount": 9,
    "totalLocatedCapacity": 67132128,
    "blockingMode": "NB",
    "totalReservedCapacity": 0,
    "reservedVolumeCount": 0,
    "poolType": "HDP",
    "duplicationLdevIds": [
        49151,
        49150,
        49149,
        49148,
        49147,
        49146,
        49145,
        49144
    ],
    "duplicationNumber": 8,
    "dataReductionAccelerateCompCapacity": 13072996,
    "dataReductionCapacity": 13072996,
    "dataReductionBeforeCapacity": 13074560,
    "dataReductionAccelerateCompRate": 92,
    "duplicationRate": 5,
    "compressionRate": 86,
    "dataReductionRate": 99,
    "dataReductionAccelerateCompIncludingSystemData": {
        "isReductionCapacityAvailable": true,
        "reductionCapacity": 430080,
        "isReductionRateAvailable": true,
        "reductionRate": 3
    },
    "dataReductionIncludingSystemData": {
        "isReductionCapacityAvailable": true,
        "reductionCapacity": 430080,
        "isReductionRateAvailable": true,
        "reductionRate": 3
    },
    "snapshotUsedCapacity": 0,
    "suspendSnapshot": true
}

For a DP pool:

Attribute	Type	Description
poolId	int	Pool number
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). tierUsedCapacity (long) Amount used by the tier (MB) tierTotalCapacity (long) Total 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.
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

#: These attributes and those under objects are displayed when the pool type is HDP.

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

{
  "poolId": 3,
  "poolStatus": "POLN",
  "usedCapacityRate": 0,
  "usedPhysicalCapacityRate": 0,
  "snapshotCount": 0,
  "poolName": "pool_for_snapshot_data",
  "availableVolumeCapacity": 6006,
  "availablePhysicalVolumeCapacity": 6006,
  "totalPoolCapacity": 6006,
  "totalPhysicalCapacity": 6006,
  "numOfLdevs": 1,
  "firstLdevId": 1026,
  "warningThreshold": 80,
  "virtualVolumeCapacityRate": -1,
  "isMainframe": false,
  "isShrinking": false,
  "poolType": "HTI"
}

For a Thin Image pool:

Attribute	Type	Description
poolId	int	Pool number
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

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/18