概述
本文档详细的描述了MEF Center RESTful接口的相关说明。指导用户通过调用RESTful接口实现对MEF功能的使用。
Redfish是一种基于HTTPS服务的管理标准,利用RESTful接口实现设备管理。每个HTTPS操作都以UTF-8编码的JSON的形式,提交或返回一个资源。就像Web应用程序向浏览器返回HTML一样,RESTful接口会通过同样的传输机制(HTTPS),以JSON的形式向客户端返回数据,本文档中通过JSON格式传入的参数名不区分大小写。
MEF提供的所有RESTful接口仅支持串行调用。
返回状态码
状态码 |
说明 |
---|---|
200 |
请求成功。 |
400 |
请求非法,客户端侧发生错误并返回错误消息。 |
401 |
未认证,请求要求用户的身份认证。 |
404 |
访问请求资源不存在。 |
405 |
请求方法非法。如使用错误的方法类型进行请求。 |
423 |
当前资源被锁定。 |
429 |
发送请求过多,超出频次限制。 |
499 |
客户端断开了连接。 |
503 |
由于服务器维护或者过载,服务器当前无法处理请求。 |
URL参数
调用接口时,需要输入具体接口的URL。URL都需要传入以下参数,其他的URL参数请参见每个接口的URL参数说明。
参数名 |
是否必选 |
参数说明 |
取值要求 |
---|---|---|---|
ip |
必选 |
登录设备的IP地址 |
IPv4地址。 |
port |
必选 |
调用具体模块接口的端口号 |
- |
请求头参数
本文档涉及到的请求头参数说明如下。
参数名 |
是否必选 |
参数说明 |
取值要求 |
---|---|---|---|
Content-Type |
必选 |
媒体类型 |
字符串,取值为“application/json”,在请求头中携带。 |
父主题: 接口参考