Getting drive information

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter Condition
poolId	int	(Optional) ID of the pool to which the drives belong If poolName is specified, do not specify this parameter.
poolName	string	(Optional) Name of the pool to which the drives belong Drive information will also be obtained if part of the specified value matches a pool name. If poolId is specified, do not specify this parameter. If both poolId and this parameter are specified, this parameter is ignored.
status	string	(Optional) Specify any of the following values as the status of the drives to obtain: Normal: The drive with a status of normal. Warning: An error has occurred in a part of the drive. Copying: Copying is in progress. CopyIncomplete: Copying is incomplete. Reserved: The spare drive cannot be used. Failed: The drive is in the error status because of a failure. Blocked: The drive is in the error status because it is under maintenance.
useOfTheDrive	string	(Optional) Specify any of the following values as the purpose of the drives to obtain: data: Data drive spare: Spare drive free: Unused drive

Body

None.

Response message

Body

The following is an example of output when drive information is obtained for drives that are not in use (drives for which free is specified for the useOfTheDrive query parameter):

{
    "data": [
        {
            "location": "0-0",
            "status": "Normal",
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_10000",
            "driveCapacity": 300,
            "displayDriveCapacity": "300 GB",
            "typeCode": "DKR5C-J300SS",
            "poolIds": [],
            "useOfTheDrive": "free"
        },
        {
            "location": "0-1",
            "status": "Normal",
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_10000",
            "driveCapacity": 300,
            "displayDriveCapacity": "300 GB",
            "typeCode": "DKR5C-J300SS",
            "poolIds": [],
            "useOfTheDrive": "free"
        },
        {
            "location": "0-2",
            "status": "Normal",
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_10000",
            "driveCapacity": 300,
            "displayDriveCapacity": "300 GB",
            "typeCode": "DKR5C-J300SS",
            "poolIds": [],
            "useOfTheDrive": "free"
        },
        {
            "location": "0-3",
            "status": "Normal",
            "driveType": "HDD",
            "driveInterface": "SAS",
            "driveRpm": "NUMBER_10000",
            "driveCapacity": 300,
            "displayDriveCapacity": "300 GB",
            "typeCode": "DKR5C-J300SS",
            "poolIds": [],
            "useOfTheDrive": "free"
        }
  ],
  "count": 4
}

Attribute	Type	Description
location	string	Mounted location of the drive. Also commonly referred to as "name" or "ID".
status	string	Status of the drive: Normal: The drive with a status of normal. Warning: An error has occurred in a part of the drive. Copying: Copying is in progress. CopyIncomplete: Copying is incomplete. Reserved: The spare drive cannot be used. Failed: The drive is experiencing an error because of a failure. Blocked: The drive is experiencing an error because it is under maintenance. Unknown: The status is unknown.
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)
typeCode	string	Drive type code
poolIds	int[]	List of pool IDs to which the drives belong
useOfTheDrive	string	Purpose of the drive: data: Data drive spare: Spare drive free: Unused drive

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/drives?useOfTheDrive=free