Querying System Resource Information
Function
This interface is used to query information about the current system resource collection.
Syntax
Operation type: GET
URL: https://device_ip/redfish/v1/Systems
Request header:
X-Auth-Token: auth_value
Request message body: None
Usage Guidelines
None
Example
Request:
GET https://10.10.10.10/redfish/v1/Systems
Request header:
X-Auth-Token: auth_value
Request message body: None
{
"@odata.context": "/redfish/v1/$metadata#Systems",
"@odata.id": "/redfish/v1/Systems",
"@odata.type": "#ComputerSystem.v1_18_0.ComputerSystem",
"Id": "1",
"Name": "Computer System",
"HostName": "Euler",
"UUID": "025VLB10K6000019",
"Model": "Atlas 200 DK A2",
"SupportModel": "Atlas 200 DK A2",
"SerialNumber": "2102312NNU10K7000017",
"AssetTag": "perl",
"Status": {
"Health": "OK"
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/Processors"
},
"Memory": {
"@odata.id": "/redfish/v1/Systems/Memory"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/EthernetInterfaces"
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/LogServices"
},
"SimpleStorages": {
"@odata.id": "/redfish/v1/Systems/SimpleStorages"
},
"Oem": {
"PCBVersion": 1,
"Temperature": 50,
"Power": 23,
"Voltage": 0.02,
"CpuHeating": "Stop",
"DiskHeating": "Stop",
"UsbHubHeating": "Heating",
"AiTemperature": 55,
"ProcessorArchitecture": "ARM",
"OSVersion": "EulerOS 2.0 (SP10)",
"KernelVersion": "4.19.90",
"Uptime": "06:56:58 up 6 min",
"Datetime": "Wed Nov 16 06:56:58 UTC 2022",
"DateTimeLocalOffset": "UTC (UTC, +0000)",
"CpuUsage": 9.09,
"MemoryUsage": 16.31,
"Firmware": [
{
"Version": "3.0",
"InactiveVersion": "3.0",
"Module": "MindXOM",
"BoardId": "",
"UpgradeResult": false,
"UpgradeProcess": 0
},
]
"InactiveConfiguration": null,
"NTPService": {
"@odata.id": "/redfish/v1/Systems/NTPService"
},
"ExtendedDevices": {
"@odata.id": "/redfish/v1/Systems/ExtendedDevices"
},
"LTE": {
"@odata.id": "/redfish/v1/Systems/LTE"
},
"Partitions": {
"@odata.id": "/redfish/v1/Systems/Partitions"
},
"NfsManage": {
"@odata.id": "/redfish/v1/Systems/NfsManage"
},
"SecurityService": {
"@odata.id": "/redfish/v1/Systems/SecurityService"
},
"Alarm": {
"@odata.id": "/redfish/v1/Systems/Alarm"
},
"SystemTime": {
"@odata.id": "/redfish/v1/Systems/SystemTime"
},
"EthIpList": {
"@odata.id": "/redfish/v1/Systems/EthIpList"
},
"Modules": {
"@odata.id": "/redfish/v1/Systems/Modules"
}
},
"Actions": {
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/Actions/ComputerSystem.Reset"
},
"Oem": {
"#RestoreDefaults.Reset": {
"target": "/redfish/v1/Systems/Actions/RestoreDefaults.Reset"
}
}
}
}
Response code: 200
Output Description
Field |
Type |
Description |
|---|---|---|
@odata.context |
String |
OData description of a system resource model. |
@odata.id |
String |
System resource access path. |
@odata.type |
String |
Type of a system resource. |
Id |
String |
System resource ID. |
Name |
String |
System resource name. |
HostName |
String |
System host name. |
UUID |
String |
Unique identifier of the system. |
Model |
String |
Product name. |
SupportModel |
String |
Name of the product that can be updated. |
SerialNumber |
String |
Product SN. |
AssetTag |
String |
User-defined electronic label. |
Status |
Object |
System resource status. Health: indicates the health status of a system resource. |
Processors |
Object |
Path to access the processor interface resource. |
Memory |
Object |
Path to access the memory interface resource. |
EthernetInterfaces |
Object |
Path to access the Ethernet interface resource. |
LogServices |
Object |
Path to access the log interface resource. |
SimpleStorages |
Object |
Path to access the simple storage interface resource. |
Oem |
Object |
Custom attribute. |
PCBVersion |
Number |
PCB version. |
Temperature |
Number |
System temperature. |
Power |
Number |
System power. |
Voltage |
Number |
System voltage. |
CpuHeating |
String |
CPU heating status. |
DiskHeating |
String |
Drive heating status. |
UsbHubHeating |
String |
USB hub heating status. |
AiTemperature |
Number |
MiniD temperature. |
ProcessorArchitecture |
String |
Processor architecture. |
OSVersion |
String |
OS version. |
KernelVersion |
String |
OS kernel version. |
Uptime |
String |
Continuous running time of the system. |
Datetime |
String |
Current system time. NOTE:
Due to system data cache, the returned time is 20s deviation from the system time. |
DateTimeLocalOffset |
String |
Time zone of the system. |
CpuUsage |
Number |
CPU usage, in percentage. The value ranges from 0 to 100. |
MemoryUsage |
Number |
Memory usage, in percentage. The value ranges from 0 to 100. |
Firmware |
List |
Firmware list.
|
Version |
String |
Current version. |
InactiveVersion |
String |
Version to take effect. |
Module |
String |
Firmware name.
|
BoardId |
String |
Board ID. |
UpgradeResult |
Boolean |
Firmware update result.
|
UpgradeProcess |
Number |
Update progress. |
InactiveConfiguration |
String |
Name of the profile that has not taken effect and has been imported. |
NTPService |
Object |
Path to access the NTPService interface resource. |
ExtendedDevices |
Object |
Path to access the external device interface resource. |
LTE |
Object |
Path to access the wireless network interface resource. |
Partitions |
Object |
Path to access the drive partition interface resource. |
NfsManage |
Object |
Path to access the NfsManage interface resource. |
SecurityService |
Object |
Path to access the security service interface resource. |
Alarm |
Object |
Path to access the alarm interface resource. |
SystemTime |
Object |
Path to access the system time interface resource. |
EthIpList |
Object |
Path to access the interface resource for obtaining the network port and IP address list. |
Modules |
Object |
Path to access the external device module interface resource. |
Actions |
Object |
Operations that can be performed. |
#ComputerSystem.Reset |
Object |
OS restart operation. |
#RestoreDefaults.Reset |
Object |
Factory setting restoration. |