Getting pool information

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/pools

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter Condition
name	string	(Optional) Pool name Pool information will also be obtained if part of the specified value matches a pool name.
status	string	(Optional) Specify the following values to obtain information about the pools with a specific status: Normal: The pools with a status of normal. ExceededThreshold: The pools where the usage rate exceeds the threshold value. Error: The pools that are in the error status because they are full.
configStatus	string	(Optional) Specify PartiallyBlocked (some of the volumes that make up the pools are blocked) as the status of the volumes that make up the pools to obtain.

Body

None.

Response message

Body

{
    "data": [
        {
            "id": 4,
            "name": "Pool5_External",
            "status": "Normal",
            "totalCapacity": 20480,
            "usedCapacity": 0,
            "freeCapacity": 20480,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 12345,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 220
            },
            "configStatus": [],
            "numberOfVolumes": 0,
            "numberOfTiers": 0,
            "tiers": []
        },
        {
            "id": 3,
            "name": "Pool4",
            "status": "Normal",
            "totalCapacity": 65536000,
            "usedCapacity": 0,
            "freeCapacity": 65536000,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 12345,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 220
            },
            "configStatus": [],
            "numberOfVolumes": 50,
            "numberOfTiers": 0,
            "tiers": []
        },
        {
            "id": 2,
            "name": "Pool3",
            "status": "Normal",
            "totalCapacity": 9830400,
            "usedCapacity": 81920,
            "freeCapacity": 9748480,
            "capacityManage": {
                "usedCapacityRate": 1,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 12345,
                "preCapacityFmdSaving": 0,
                "postCapacityFmdSaving": 0,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 220
            },
            "configStatus": [],
            "numberOfVolumes": 50,
            "numberOfTiers": 0,
            "tiers": []
        },
        {
            "id": 1,
            "name": "Pool2",
            "status": "Normal",
            "totalCapacity": 26214400,
            "usedCapacity": 0,
            "freeCapacity": 26214400,
            "capacityManage": {
                "usedCapacityRate": 0,
                "thresholdWarning": 70,
                "thresholdDepletion": 80
            },
            "savingEffects": {
                "efficiencyDataReduction": 220,
                "efficiencyFmdSaving": 12345,
                "preCapacityFmdSaving": 617,
                "postCapacityFmdSaving": 4,
                "isTotalEfficiencySupport": true,
                "totalEfficiencyStatus": "Valid",
                "dataReductionWithoutSystemDataStatus": "Valid",
                "totalEfficiency": 12345,
                "dataReductionWithoutSystemData": 220
            },
            "configStatus": [],
            "numberOfVolumes": 50,
            "numberOfTiers": 2,
            "tiers": [
                {
                    "driveType": "Flash Drive",
                    "driveRpm": "NUMBER_0",
                    "totalCapacity": 16384000,
                    "usedCapacity": 0
                },
                {
                    "driveType": "HDD",
                    "driveRpm": "NUMBER_10000",
                    "totalCapacity": 9830400,
                    "usedCapacity": 0
                }
            ]
        }
    ],
    "count": 4
}

Attribute	Type	Description
id	int	Pool ID
name	string	Pool name
status	string	State of the pool: Normal: The pool is in normal status. ExceededThreshold: The pool usage rate exceeds the threshold value. Error: The pools that are in the error status because they are full.
encryption	string	Encryption status of the pool ENABLED: Pool Encryption is enabled. DISABLED: Pool Encryption is disabled. MIXED: Encryption is mixed by enabled and disabled. UNKNOWN_EXTERNAL_VOLUME: The encryption status of the pool is unknown because the pool includes an external volume. UNKNOWN: The encryption status of the pool is unknown because the pool is blocked. This attribute appears if the VSP E series storage system is used.
totalCapacity	long	Total capacity of the pool (MiB)
usedCapacity	long	Used capacity of the pool (MiB)
freeCapacity	long	Free capacity of the pool (MiB)
capacityManage	object	Configuration information about the pool capacity: usedCapacityRate (int) Pool usage rate (%) thresholdWarning (int) Warning threshold value of the pool (%) thresholdDepletion (int) Depletion threshold value of the pool (%)
savingEffects	object	Information such as the rate of saving capacity: efficiencyDataReduction (int) 1 Percentage of the pool's capacity saved by using the capacity saving (deduplication and compression) The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100. Example: If the value before reduction is 105 and the value after reduction is 100, "efficiencyDataReduction": 105 appears. If -1 appears, this value is invalid. Invalid value -1 is returned in case of that there is no data subject to reduction. efficiencyFmdSaving (int) Percentage of the pool's capacity saved by using the accelerated compression The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100. Example: If the value before reduction is 105 and the value after reduction is 100, "efficiencyFmdSaving": 105 appears. If -1 appears, this value is invalid. Invalid value -1 is returned in case of that there is no data subject to reduction. For VSP E series storage systems, -1 appears, indicating an invalid value. preCapacityFmdSaving (long) Pool capacity before reduction by using the accelerated compression If the invalid value -1 appears for the attribute efficiencyFmdSaving, 0 appears for this attribute. postCapacityFmdSaving (long) Pool's capacity after reduction by using the accelerated compression If the invalid value -1 appears for the attribute efficiencyFmdSaving, 0 appears for this attribute. isTotalEfficiencySupport (boolean) Whether the total efficiency feature is supported true: Supported false: Not supported totalEfficiencyStatus (string) Status of the total efficiency feature for all volumes stored in the pool Valid: Valid NotSupported: Not supported CalculationInProgress: Being calculated NoTargetData: No data to calculate Unknown: Unknown dataReductionWithoutSystemDataStatus (string) Status of the pool capacity saved by using the capacity saving (deduplication and compression) and the accelerated compression Valid: Valid NotSupported: Not supported CalculationInProgress: Being calculated NoTargetData: No data to calculate Unknown: Unknown For VSP E series storage systems, the saving efficiency achieved by using the accelerated compression function is not included. totalEfficiency(long)2 Percentage indicating the total efficiency for all volumes stored in the pool The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100. Example: If the value before reduction is 6742 and the value after reduction is 100, "totalEfficiency": 6742 appears. After a volume is created from a pool and before data is written to the volume, the maximum value (9223372036854775807) appears. By checking the attribute calculationStartTime or calculationEndTime, you can check the date and time when calculation processing started or finished. In the following cases, -1 appears, to indicate an invalid value. The value of the attribute isTotalEfficiencySupport is false. The value of the attribute totalEfficiencyStatus is NotSupported, CalculationInProgress, or NoTargetData. dataReductionWithoutSystemData (long)2 Percentage of the pool capacity saved by using the capacity saving (deduplication and compression) and the accelerated compression The value before reduction appears. This value is calculated under the assumption that the value after reduction is 100. Example: If the value before reduction is 138 and the value after reduction is 100, "dataReductionWithoutSystemData": 138 appears. For VSP E series storage systems, the saving efficiency achieved by using the accelerated compression function is not included. In the following cases, -1 appears, to indicate an invalid value. By checking the attribute calculationStartTime or calculationEndTime, you can check the date and time when calculation processing started or finished. The value of the attribute isTotalEfficiencySupport is false. The value of the attribute dataReductionWithoutSystemDataStatus is NotSupported, CalculationInProgress, or NoTargetData. calculationStartTime (ISO8601string) The date and time (UTC) when calculation processing started appears in the following format: YYYY-MM-DDThh:mm:ssZ. calculationEndTime (ISO8601string) The date and time (UTC) when calculation processing finished appears in the following format: YYYY-MM-DDThh:mm:ssZ.
configStatus	string[]	Status of the volumes that make up the pool PartiallyBlocked: Some of the volumes that make up the pool are blocked
numberOfVolumes	int	Number of volumes associated with the pool
numberOfTiers	int	Number of tiers that make up the pool
tiers	object[]	Attributes about tiers for each tier: driveType (string) One of the following drive types appears: Flash Drive HDD External Storage Mixed Unknown driveRpm (string) Drive rotation speed per minute totalCapacity (long) Total capacity of the tier (MiB) usedCapacity (long) Used capacity of the tier (MiB)
subscriptionLimit	object	Information about settings related to the subscription limit rate for volumes associated with the pool This attribute appears for VSP E series storage systems. isEnabled (boolean) Whether the subscription limit rate is enabled true: Enabled false: Disabled If false appears, this indicates that the subscription limit rate is unlimited. limitRate (int) Subscription limit value of the pool (%) This attribute appears only if the isEnabled attribute is true. currentRate (long) The current subscription rate (%) The total size of the following types of data associated with the pool: Metadata and garbage data generated by the storage system Volume Snapshot The formula used to calculate the value that appears for this attribute does not uniformly round down values. For this reason, depending on the calculation result, the value that appears might have been rounded up to the nearest whole number. Values in the range from 0 to 1 or in the range from 100 to 101 are rounded up to the nearest whole number when displayed. All other values are rounded down to the nearest whole number when displayed.
containsCapacitySavingVolume	boolean	Whether the pool includes volumes for which the capacity saving (deduplication and compression functions) is enabled true: The volumes are included false: The volumes are not included This attribute appears only for VSP E series storage systems.
1 The capacity after reduction is calculated based on a value that includes metadata and garbage data generated by the storage system, in addition to user data. For this reason, the value after reduction is sometimes greater than the value before reduction. 2 The capacity after reduction does not include metadata and garbage data generated by the storage system.

Status codes

See HTTP status codes.

Coding example

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