Redfish Overview
Redfish is an HTTPS-based management standard that 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.
The Redfish's goal of addressing all the components in the data center with a consistent API adapts to the development trend towards universal software interfaces in the Internet industry. Redfish provides advantages, such as easy to use and high 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.
All the Redfish features described in this document are based on Redfish version 1.0.2 and Schema 2016.1.
Resource Operations
Operation |
Description |
|---|---|
GET resource URI |
Returns information about the requested resource. |
POST resource URI |
Creates a resource or performs the specified action for a resource. |
PATCH resource URI |
Modifies resource properties. |
DELETE resource URI |
Deletes a resource. |
Returned Status Code
Status Code |
Description |
|---|---|
200 |
The request is successful. |
201 |
The resource is created successfully. |
202 |
The task is created successfully. |
400 |
Illegal request. 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 request causes a conflict in the current state of the resources. |
500 |
Server internal error. |
501 |
The requested function is not available at present. |
