Getting information about a specific pool

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request gets information about a specific pool by using the specified pool ID.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify a value for the id that was obtained by getting information about pools.

Attribute

Type

Description

id

int

(Required) Pool ID

Query parameters
None.
Body
None.

Response message

Body

The following is an example of output when getting information about a pool with ID 0:

{
    "id": 1,
    "name": "DpPool_001",
    "status": "Normal",
    "encryption": "DISABLED",
    "totalCapacity": 10240,
    "usedCapacity": 0,
    "freeCapacity": 10240,
    "capacityManage": {
        "usedCapacityRate": 0,
        "thresholdWarning": 70,
        "thresholdDepletion": 80
    },
    "savingEffects": {
        "efficiencyDataReduction": 220,
        "efficiencyFmdSaving": 120,
        "preCapacityFmdSaving": 0,
        "postCapacityFmdSaving": 0,
        "isTotalEfficiencySupport": true,
        "totalEfficiencyStatus": "Valid",
        "dataReductionWithoutSystemDataStatus": "Valid",
        "softwareSavingWithoutSystemDataStatus": "Valid",
        "totalEfficiency": 12345,
        "dataReductionWithoutSystemData": 102,
        "softwareSavingWithoutSystemData": 103,
        "calculationStartTime": "2022-02-24T01:14:12Z",
        "calculationEndTime": "2022-02-24T01:24:12Z"
    },
    "configStatus": [],
    "numberOfVolumes": 25,
    "numberOfTiers": 3,
    "numberOfDriveTypes": 3,
    "tiers": [
        {
            "driveType": "Flash Drive",
            "driveRpm": "NUMBER_0",
            "totalCapacity": 13107200,
            "usedCapacity": 0
        },
        {
            "driveType": "HDD",
            "driveRpm": "NUMBER_15000",
            "totalCapacity": 2457600,
            "usedCapacity": 0
        },
        {
            "driveType": "HDD",
            "driveRpm": "NUMBER_7200",
            "totalCapacity": 32768000,
            "usedCapacity": 0
        }
    ],
    "drives": [
        {
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_7200",
            "driveCapacity": 4000,
            "displayDriveCapacity": "4 TB",
            "totalCapacity": 32000,
            "numberOfDrives": 8,
            "locations": [
                "8-0",
                "8-1",
                "8-2",
                "8-3",
                "8-4",
                "8-5",
                "8-6",
                "8-7"
            ],
            "raidLevel": "RAID6"
        },
        {
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_15000",
            "driveCapacity": 300,
            "displayDriveCapacity": "300 GB",
            "totalCapacity": 2400,
            "numberOfDrives": 8,
            "locations": [
                "12-0",
                "12-1",
                "12-2",
                "12-3",
                "12-4",
                "12-5",
                "12-6",
                "12-7"
            ],
            "raidLevel": "RAID6"
        },
        {
            "driveType": "FMD DC2",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_0",
            "driveCapacity": 1600,
            "displayDriveCapacity": "1.6 TB",
            "totalCapacity": 12800,
            "numberOfDrives": 8,
            "locations": [
                "7-0",
                "7-1",
                "7-2",
                "7-3",
                "7-4",
                "7-5",
                "7-6",
                "7-7"
            ],
            "raidLevel": "RAID6"
        }
    ],
    "subscriptionLimit": {
        "isEnabled": false,
        "currentRate": 250
    },
    "containsCapacitySavingVolume": false
}

This operation obtains the values of attributes obtained as part of the pool information, as well as the values of the following attributes.

Attribute

Type

Description

numberOfDriveTypes

int

Number of drive types

drives

object[]

Drive information:

  • driveType (string)

    Drive type:

    • HDD
    • SSD(RI)
    • SSD
    • FMD DC2: A Hitachi flash-based SSD with compression capability.
  • driveInterface (string)

    Drive interface:

    • SAS
    • NVMe
  • driveRpm (string)

    Drive rotation speed (rpm):

    • NUMBER_0
    • NUMBER_7200
    • NUMBER_10000
    • NUMBER_15000
    • High
    • Middle
    • Low
    • Unknown
  • driveCapacity (int)

    Drive capacity (GB)

  • displayDriveCapacity (string)

    Capacity of the drive and unit of measurement (GB or TB)

  • totalCapacity (long)

    Total capacity of the drive (MiB)

  • numberOfDrives (int)

    Number of drives that belong to the pool

  • locations (string[])

    Mounted locations of the drive. Also commonly referred to as "name" or "ID".

  • raidLevel (string)

    RAID level:

    • RAID1
    • RAID5
    • RAID6
    • Mixed

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