Getting a list of drive 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 request below gets a list of drive information.
Note:
  • If you are using SCM drives, see the usage notes in the manual for the relevant storage system.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/drives

Request message

Object ID
None.
Query parameters

You can filter the execution results by specifying conditions and obtain additional detailed information about the drive.

  • To filter the execution results:

    Parameter

    Type

    Filter condition

    parityGroupId

    string

    (Optional) The parity group number of the parity group to which the drive belongs

    usageType

    string

    (Optional) Purpose for which the drive is used

    You can specify the following values as filter conditions:

    • DATA: Data drive
    • SPARE: Spare drive
    • FREE: Unused drive

    driveTypeName

    string

    (Optional) Drive type

    You can specify the following values as filter conditions:

    • SAS
    • SSD(MLC)
    • SSD(FMC)
    • SSD
    • SSD(RI)
    • SCM

    SSD can be specified only for VSP 5000 series or VSP E series storage systems.

    SSD(RI) can be specified only for VSP G350, G370, G700, G900 and VSP F350, F370, F700, F900 storage systems. You cannot specify this value for VSP E series.

    SCM can be specified only for VSP 5000 series storage systems.

    driveSpeed

    int

    (Optional) Drive rotation speed (rpm)

    totalCapacity

    long

    (Optional) Physical capacity of the drive (GB)

    For this attribute, 1 GB is equal to 1,0003 bytes.

  • To obtain additional detailed information:

    Attribute

    Type

    Description

    detailInfoType

    string

    (Optional) Type of information to be collected

    To specify multiple drive types, delimit them by using commas.

    You can use this parameter in combination with the query parameters that are used to filter the execution results.

    • usedEnduranceIndicator

      If the drive type is SSD(MLC), SSD(FMC), SSD, SSD(RI), or SCM, additional detailed information about the drive's life expectancy is collected.

    • usageType

      Additional detailed information about the usage of the drive is collected.

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

Body

None.

Response message

Body
{
  "data": [
    {
      "driveLocationId": "0-0",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "totalCapacity": 600,
      "driveType": "DKR5D-J600SS",
      "usageType": "DATA",
      "status": "NML",
      "parityGroupId": "1-6",
      "serialNumber": "123456789012345678901"
    },
    {
      "driveLocationId": "0-1",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "totalCapacity": 600,
      "driveType": "DKR5D-J600SS",
      "usageType": "DATA",
      "status": "NML",
      "parityGroupId": "1-6",
      "serialNumber": "123456789012345678902"
    },
    {
      "driveLocationId": "0-2",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "totalCapacity": 600,
      "driveType": "DKR5D-J600SS",
      "usageType": "DATA",
      "status": "NML",
      "parityGroupId": "1-6",
      "serialNumber": "123456789012345678903"
    },
    {
      "driveLocationId": "0-3",
      "driveTypeName": "SAS",
      "driveSpeed": 10000,
      "totalCapacity": 600,
      "driveType": "DKR5D-J600SS",
      "usageType": "DATA",
      "status": "NML",
      "parityGroupId": "1-6",
      "serialNumber": "123456789012345678904"
    }
  ]
}

Attribute

Type

Description

driveLocationId

string

Drive location (location of the drive box)

driveTypeName

string

Drive type

driveSpeed

int

Drive rotation speed (rpm)

totalCapacity

long

Drive capacity (GB)

For this attribute, 1 GB is equal to 1,0003 bytes.

driveType

string

Drive type code

usageType

string

Purpose for which the drive is used

  • DATA: Data drive
  • SPARE: Spare drive
  • FREE: Unused drive

status

string

Status of the drive

  • NML: Normal
  • WAR: Part of the drive is blocked
  • CPY: Copying is in progress
  • CPI: Copying is incomplete
  • RSV: The spare drive cannot be used
  • FAI: The drive is blocked because of a failure
  • BLK: The drive is blocked because maintenance is being performed
  • Unknown or UNK: The status is unknown

parityGroupId

string

Parity group number

This item is hidden when the drive does not belong to any parity group.

serialNumber

string

Serial number of the drive

The following is an example of the detailed information that can be output about the drive's life expectancy.

{
    "data": [
        {
            "driveLocationId": "4-0",
            "driveTypeName": "SSD(FMC)",
            "totalCapacity": 1600,
            "driveType": "NFHAE-Q1R6SS",
            "usageType": "DATA",
            "status": "NML",
            "parityGroupId": "3-1",
            "serialNumber": "12345670",
            "usedEnduranceIndicator": 0,
            "usedEnduranceIndicatorThreshold": 99,
            "usedEnduranceIndicatorWarningSIM": 95
        },
        {
            "driveLocationId": "4-1",
            "driveTypeName": "SSD(FMC)",
            "totalCapacity": 1600,
            "driveType": "NFHAE-Q1R6SS",
            "usageType": "DATA",
            "status": "NML",
            "parityGroupId": "3-1",
            "serialNumber": "12345671",
            "usedEnduranceIndicator": 0,
            "usedEnduranceIndicatorThreshold": 99,
            "usedEnduranceIndicatorWarningSIM": 95
        },
        {
            "driveLocationId": "4-2",
            "driveTypeName": "SSD(FMC)",
            "totalCapacity": 1600,
            "driveType": "NFHAE-Q1R6SS",
            "usageType": "DATA",
            "status": "NML",
            "parityGroupId": "3-1",
            "serialNumber": "12345672",
            "usedEnduranceIndicator": 0,
            "usedEnduranceIndicatorThreshold": 99,
            "usedEnduranceIndicatorWarningSIM": 95
        }
    ]
}

To obtain detailed information about the drive's life expectancy:

If the drive type is SSD(MLC), SSD(FMC), SSD, SSD(RI), or SCM, you can obtain the following information by executing the request with usedEnduranceIndicator specified for the detailInfoType query parameter.

Attribute

Type

Description

usedEnduranceIndicator

int

Life expectancy of the drive (%)

A value in the range from 0 to 100 is displayed.

A large value indicates that the drive is near the end of its life expectancy.

usedEnduranceIndicatorThreshold

int

Threshold value of the drive's life expectancy (%)

If the value of the drive's life expectancy exceeds this value, data on the drive will be automatically copied to a spare drive.

usedEnduranceIndicatorWarningSIM

int

Threshold value of the warning SIM (%)

If the value of the drive's life expectancy exceeds this value, error information (SIM) will be displayed.

The following is an example of the detailed information that can be output about the drive usage.

{
    "data": [
        {
            "driveLocationId": "0-0",
            "driveTypeName": "SAS",
            "driveSpeed": 10000,
            "totalCapacity": 600,
            "driveType": "DKS5H-J600SS",
            "usageType": "DATA",
            "detailUsageType": "DATA",
            "status": "NML",
            "parityGroupId": "1-1",
            "serialNumber": "12345670"
        },
        {
            "driveLocationId": "0-1",
            "driveTypeName": "SAS",
            "driveSpeed": 10000,
            "totalCapacity": 600,
            "driveType": "DKS5H-J600SS",
            "usageType": "DATA",
            "detailUsageType": "DATA",
            "status": "NML",
            "parityGroupId": "1-1",
            "serialNumber": "12345671"
        },
        {
            "driveLocationId": "0-2",
            "driveTypeName": "SAS",
            "driveSpeed": 10000,
            "totalCapacity": 600,
            "driveType": "DKS5H-J600SS",
            "usageType": "DATA",
            "detailUsageType": "DATA",
            "status": "NML",
            "parityGroupId": "1-1",
            "serialNumber": "12345671"
        },
        {
            "driveLocationId": "0-3",
            "driveTypeName": "SAS",
            "driveSpeed": 10000,
            "totalCapacity": 600,
            "driveType": "DKS5H-J600SS",
            "usageType": "DATA",
            "detailUsageType": "DATA",
            "status": "NML",
            "parityGroupId": "1-1",
            "serialNumber": "12345671"
        }
    ]
}

To obtain detailed information about the drive usage:

You can obtain the following information by specifying usageType for the detailInfoType query parameter.

Attribute

Type

Description

detailUsageType

string

Details about the usage of the drive

  • DATA: Data drive

  • SPARE: Spare drive

  • FREE: Unused drive

  • SWAP: the drive that is swapped a spare drive for a data drive

  • RESERVE: the unused drive that is swapped a data drive for a spare drive

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

totalLogicalCapacity

long

Logical capacity of the drive (GB)

Status codes

For details on the status codes of the request for this operation, see the description of 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/drives