Querying Simple Storage Resource Information

Function

This interface is used to query information about a specified storage resource.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/SimpleStorages/<storage_id>

Request header:

X-Auth-Token: auth_value

Request message body: None

URL Parameters

Table 1 URL parameters

Parameter

Mandatory/Optional

Parameter Description

Value

<storage_id>

Mandatory

ID of a storage resource.

The value is a number, which can be obtained from the storage collection resource list.

  • 1: disk
  • 2: u-disk
  • 3: eMMC. The M.2 general system does not support eMMC query.

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/SimpleStorages/3

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    @odata.context: "/redfish/v1/$metadata#Systems/Members/SimpleStorages/Members/$entity",
    @odata.id: "/redfish/v1/Systems/SimpleStorages/3",
    @odata.type: "#SimpleStorage.v1_3_1.SimpleStorage",
    Id: "3",
    Name: "eMMC",
    Description: "System eMMC Flash",
    Status: {
        State: "Enabled",
        Health: "OK"
    },
    "Devices": [{
        "Name": "/dev/mmcblk0",
        "Manufacturer": "Hynix",
        "Model": "HBG4a2",
        "CapacityBytes": "31268536320",
        "LeftBytes": "588251136",
        "PartitionStyle": "GPT",
        "Location": "eMMC1",
        "DeviceLifeTimeUsed": 2
        "Status": {
            "State": "Enabled",
            "Health": "OK"
        }
    }]
}

Response code: 200

Output Description

Table 2 Operation output description

Field

Type

Description

@odata.context

Character string

OData description of a simple storage resource model.

@odata.id

Character string

Path to access a simple storage resource.

@odata.type

Character string

Type of a simple storage resource.

Id

Character string

ID of a simple storage resource.

Name

Character string

Name of a simple storage resource.

Description

Character string

Description of a simple storage resource.

Status

Object

Status of a specified simple storage controller:

  • State: indicates whether a storage controller is enabled.
  • Health: indicates the health status of a storage controller.

Devices[]

Array

List of connected devices.

Devices [].Name

Character string

Name of a connected device.

Devices [].Manuafacturer

Character string

Vendor of a connected device.

Devices [].Model

Character string

Model of a connected device.

Devices [].CapacityBytes

Character string

Capacity of a connected device.

Devices [].LeftBytes

Character string

Remaining capacity of a connected device.

Devices[].PartitionStyle

Character string

Partition format.

  • GPT
  • MBR

Devices[].Location

Character string

Device location.

Devices[].DeviceLifeTimeUsed

Number

Service life of a device. The values are as follows:

  • 0: undefined
  • 1: 0% to 10% of service life has been used.
  • 2: 10% to 20% of service life has been used.
  • 3: 20% to 30% of service life has been used.
  • 4: 30% to 40% of service life has been used.
  • 5: 40% to 50% of service life has been used.
  • 6: 50% to 60% of service life has been used.
  • 7: 60% to 70% of service life has been used.
  • 8: 70% to 80% of service life has been used.
  • 9: 80% to 90% of service life has been used.
  • 10: 90% to 100% of service life has been used.
  • 11: The expected maximum service life has been reached.
  • others: reserved

Devices [].Status

Object

Status of a connected device:

  • State: indicates whether a storage controller is enabled.
  • Health: indicates the health status of a storage controller.