Introduction

This document describes MEF Center RESTful APIs, to help you to enable MEF functions.

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 the web application returning HTML to the browser, RESTful interfaces return data to the client in JSON format through the transmission mechanism HTTPS. In this document, the parameter names transferred in JSON format are case insensitive.

All RESTful APIs provided by MEF can be called only in serial mode.

Returned Status Code

Table 1 Status code description

Status Code

Description

200

A successful request.

400

An invalid request. An error occurs on the client and an error message is returned.

401

Unauthenticated. The user identity must be authenticated.

404

The requested resource does not exist.

405

The request method is invalid. For example, an incorrect method type is used.

423

The resource is already locked out.

429

Too many requests are sent, exceeding the frequency limit.

499

The client is disconnected.

503

The server is currently unable to handle the request due to overloading or maintenance of the server.

URL Parameters

When invoking an interface, enter its URL. The following parameter must be added to each URL. For details about other URL parameters, see the URL parameter description of each interface.

Table 2 URL parameters

Parameter

Mandatory/Optional

Description

Value

ip

Mandatory

IP address for logging in to a device

IPv4 address

port

Mandatory

Port number that invokes a specific module

-

Request Header Parameter

The following table describes the request header parameter involved in this document.

Table 3 Request header

Parameter

Mandatory/Optional

Description

Value

Content-Type

Mandatory

Media type

Character string. The value is application/json, which is contained in the request header.