Overview
Redfish is a management standard based on HTTPS and uses RESTful APIs for device management. Each HTTPS method submits or returns a resource in JSON format encoded in UTF-8. Similar to web applications that return HTML to browsers, RESTful APIs use the same transmission mechanism (HTTPS) to return data in JSON format to clients.
Currently the Internet is developing towards new universal software interfaces. Redfish APIs meet such demands. Compared with previous technologies, RESTful APIs feature easy use and excellent scalability. The same Redfish data model applies not only to traditional rack servers and blade servers, but also to new server systems. This is because a data model is designed to describe its service functions to clients and room is left for flexible design from the beginning.
The description in this document is based on Redfish 1.0.0.SPC200 or Later and Schema 2016.1.
Resource Operations
Operation |
Description |
---|---|
GET resource URI |
Returns the requested resource description. |
POST resource URI |
Creates a resource or executes a specified resource. |
PATCH resource URI |
Modifies current resource properties. |
DELETE resource URI |
Deletes a specified resource. |
Returned Status Code
Status Code |
Description |
---|---|
200 |
The request is successfully processed. |
201 |
The resource is created successfully. |
202 |
The task is successfully created. |
400 |
The request is invalid. An error occurs on the client and an error message is returned. |
401 |
Invalid user request. |
403 |
The server rejects the request. |
404 |
The requested resource does not exist. |
405 |
The operation is not supported. |
409 |
The status of the requested resource conflicts with that of other resources. |
500 |
An internal server error occurs. |
501 |
The requested operation is currently unavailable. |