Resource disks | Mars OS REST APIs

Resource /webmapi/disksExpand | Collapse

APIs for storage disks (SSDs)

Deprecated since 1.0.1. See storage/disks instead.

GET /webmapi/disks

Deprecated since 1.0.1. Show status of all shelf elements

Description

Show status of all shelf elements

HTTP Example

GET /webmapi/disks

Output

Reports successful result in ResponseContentType<ContainerType<DiskDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
DISK_LIST_INFO_MAPI_DISK_NO_EXIST	14006	Disk not found.
DISK_LIST_INFO_MAPI_DISK_PARAMETER_ERROR	14007	Provide only a disk name or UID, not both.
DISK_LIST_INFO_MAPI_DISK_INVALID_UID	14063	UID provided is invalid.
SHELF_FAULT_LIST_INFO_STORAGE_INVALID_PARAMETER	29012	Invalid name or UID.
SHELF_FAULT_LIST_INFO_STORAGE_NON_EXISTANT_DEVICE	29013	Shelf not found.

Produces

application/json

Since

1.0

PUT /webmapi/disks/leds

Deprecated since 1.0.1. Control a drive's red LED

Description

Control a drive's red LED

HTTP Example

PUT /webmapi/disks/leds

Input

Pass input arguments in DiskLedModifyInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
DISK_SET_LED_MAPI_DISK_NO_EXIST	14009	Disk not found.
DISK_SET_LED_MAPI_DISK_PARAMETER_ERROR	14010	Provide only a disk name or UID, not both.
DISK_SET_LED_MAPI_DISK_SET_LED_FAILED	14012	Operation failed to set LED.
DISK_SET_LED_MAPI_DISK_INVALID_ACTION	14036	LED action is invalid.
DISK_SET_LED_MAPI_DISK_INVALID_UID	14064	UID provided is invalid.

Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/disks/paths

Deprecated since 1.0.1. Give information about all paths of the given SSD

Description

Give information about all paths of the given SSD

HTTP Example

GET /webmapi/disks/paths

Output

Reports successful result in ResponseContentType<ContainerType<DiskPathDetailsInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_NO_EXIST	14028	Disk not found.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_PARAMETER_ERROR	14029	Provide only a disk name or UID, not both.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_INVALID_UID	14061	UID provided is invalid.

Produces

application/json

Since

1.0

GET /webmapi/disks/smart

Deprecated since 1.0.1. Get drive SMART information

Description

Get drive SMART information

HTTP Example

GET /webmapi/disks/smart

Output

Reports successful result in ResponseContentType<ContainerType<DiskSmartInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
DISK_SMART_LIST_INFO_MAPI_DISK_NO_EXIST	14024	Disk not found.
DISK_SMART_LIST_INFO_MAPI_DISK_PARAMETER_ERROR	14025	Provide only a disk name or UID, not both.
DISK_SMART_LIST_INFO_MAPI_DISK_INVALID_UID	14068	UID provided is invalid.

Produces

application/json

Since

1.0

GET /webmapi/disks/{id}

Deprecated since 1.0.1. Show status of all shelf elements

Description

Show status of all shelf elements

HTTP Example

GET /webmapi/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 Key	Error Code	Error Description
DISK_LIST_INFO_MAPI_DISK_NO_EXIST	14006	Disk not found.
DISK_LIST_INFO_MAPI_DISK_PARAMETER_ERROR	14007	Provide only a disk name or UID, not both.
DISK_LIST_INFO_MAPI_DISK_INVALID_UID	14063	UID provided is invalid.
SHELF_FAULT_LIST_INFO_STORAGE_INVALID_PARAMETER	29012	Invalid name or UID.
SHELF_FAULT_LIST_INFO_STORAGE_NON_EXISTANT_DEVICE	29013	Shelf not found.

Produces

application/json

Since

1.0

GET /webmapi/disks/{id}/paths

Deprecated since 1.0.1. Get path details for a specified disk instance

Description

Get path details for a specified disk instance

HTTP Example

GET /webmapi/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 Key	Error Code	Error Description
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_NO_EXIST	14028	Disk not found.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_PARAMETER_ERROR	14029	Provide only a disk name or UID, not both.
DISK_PATH_LIST_INFO_MAPI_DISK_PATH_INVALID_UID	14061	UID provided is invalid.

Produces

application/json

Since

1.0

GET /webmapi/disks/{id}/smart

Deprecated since 1.0.1. Get disk SMART information for the specified disk instance

Description

Get disk SMART information for the specified disk instance

HTTP Example

GET /webmapi/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 Key	Error Code	Error Description
DISK_SMART_LIST_INFO_MAPI_DISK_NO_EXIST	14024	Disk not found.
DISK_SMART_LIST_INFO_MAPI_DISK_PARAMETER_ERROR	14025	Provide only a disk name or UID, not both.
DISK_SMART_LIST_INFO_MAPI_DISK_INVALID_UID	14068	UID provided is invalid.

Produces

application/json

Since

1.0