Resource /webmapi/storageExpand | Collapse

APIs for storage disks (SSDs), shelves, and RAID

Show status of all shelf elements
Description

Show status of all shelf elements

HTTP Example

GET /webmapi/storage/disks

Output

Reports successful result in ResponseContentType<ContainerType<DiskDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_LIST_INFO_MAPI_DISK_NO_EXIST14006Disk not found.
DISK_LIST_INFO_MAPI_DISK_PARAMETER_ERROR14007Provide only a disk name or UID, not both.
DISK_LIST_INFO_MAPI_DISK_INVALID_UID14063UID provided is invalid.
SHELF_FAULT_LIST_INFO_STORAGE_INVALID_PARAMETER29012Invalid name or UID.
SHELF_FAULT_LIST_INFO_STORAGE_NON_EXISTANT_DEVICE29013Shelf not found.
Produces

application/json

Since

1.0

Control a drive's red LED
Description

Control a drive's red LED

HTTP Example

PUT /webmapi/storage/disks/leds

Input

Pass input arguments in DiskLedModifyInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_SET_LED_MAPI_DISK_NO_EXIST14009Disk not found.
DISK_SET_LED_MAPI_DISK_PARAMETER_ERROR14010Provide only a disk name or UID, not both.
DISK_SET_LED_MAPI_DISK_SET_LED_FAILED14012Operation failed to set LED.
DISK_SET_LED_MAPI_DISK_INVALID_ACTION14036LED action is invalid.
DISK_SET_LED_MAPI_DISK_INVALID_UID14064UID provided is invalid.
Produces

application/json

Consumes

application/json

Since

1.0

Give information about all paths of the given SSD
Description

Give information about all paths of the given SSD

HTTP Example

GET /webmapi/storage/disks/paths

Output

Reports successful result in ResponseContentType<ContainerType<DiskPathDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_NO_EXIST14028Disk not found.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_PARAMETER_ERROR14029Provide only a disk name or UID, not both.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_INVALID_UID14061UID provided is invalid.
Produces

application/json

Since

1.0

Get drive SMART information
Description

Get drive SMART information

HTTP Example

GET /webmapi/storage/disks/smart

Output

Reports successful result in ResponseContentType<ContainerType<DiskSmartInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_SMART_LIST_INFO_MAPI_DISK_NO_EXIST14024Disk not found.
DISK_SMART_LIST_INFO_MAPI_DISK_PARAMETER_ERROR14025Provide only a disk name or UID, not both.
DISK_SMART_LIST_INFO_MAPI_DISK_INVALID_UID14068UID provided is invalid.
Produces

application/json

Since

1.0

Show status of all shelf elements
Description

Show status of all shelf elements

HTTP Example

GET /webmapi/storage/disks/{id}

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<DiskDetailsInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_LIST_INFO_MAPI_DISK_NO_EXIST14006Disk not found.
DISK_LIST_INFO_MAPI_DISK_PARAMETER_ERROR14007Provide only a disk name or UID, not both.
DISK_LIST_INFO_MAPI_DISK_INVALID_UID14063UID provided is invalid.
SHELF_FAULT_LIST_INFO_STORAGE_INVALID_PARAMETER29012Invalid name or UID.
SHELF_FAULT_LIST_INFO_STORAGE_NON_EXISTANT_DEVICE29013Shelf not found.
Produces

application/json

Since

1.0

Get path details for a specified disk instance
Description

Get path details for a specified disk instance

HTTP Example

GET /webmapi/storage/disks/{id}/paths

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<ContainerType<DiskPathDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_NO_EXIST14028Disk not found.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_PARAMETER_ERROR14029Provide only a disk name or UID, not both.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_INVALID_UID14061UID provided is invalid.
Produces

application/json

Since

1.0

Get disk SMART information for the specified disk instance
Description

Get disk SMART information for the specified disk instance

HTTP Example

GET /webmapi/storage/disks/{id}/smart

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<DiskSmartInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
DISK_SMART_LIST_INFO_MAPI_DISK_NO_EXIST14024Disk not found.
DISK_SMART_LIST_INFO_MAPI_DISK_PARAMETER_ERROR14025Provide only a disk name or UID, not both.
DISK_SMART_LIST_INFO_MAPI_DISK_INVALID_UID14068UID provided is invalid.
Produces

application/json

Since

1.0

Display the state and status of the RAID Group
Description

Display the state and status of the RAID Group

HTTP Example

GET /webmapi/storage/raid/status

Output

Reports successful result in ResponseContentType<ContainerType<RaidStatusInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Produces

application/json

Since

1.0.1

Get shelf information
Description

Get shelf information

HTTP Example

GET /webmapi/storage/shelves

Output

Reports successful result in ResponseContentType<ContainerType<ShelfDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
SHELF_LIST_INFO_MAPI_SES_NO_EXIST29010Shelf ID or name provided does not match any shelves.
SHELF_LIST_INFO_STORAGE_INVALID_PARAMETER29011Invalid name or UID.
Produces

application/json

Since

1.0

Get a specified shelf instance
Description

Get a specified shelf instance

HTTP Example

GET /webmapi/storage/shelves/{id}

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<ShelfDetailsInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
SHELF_LIST_INFO_MAPI_SES_NO_EXIST29010Shelf ID or name provided does not match any shelves.
SHELF_LIST_INFO_STORAGE_INVALID_PARAMETER29011Invalid name or UID.
Produces

application/json

Since

1.0