RESTful接口

OM SDK提供标准的RESTful接口供开发者进行查看或者调用；支持开发者进行硬件基础管理功能的二次开发或集成。

Redfish是一种基于HTTPS服务的管理标准，利用RESTful接口实现设备管理。每个HTTPS操作都以UTF-8编码的JSON的形式，提交或返回一个资源。就像Web应用程序向浏览器返回HTML一样，RESTful接口会通过同样的传输机制（HTTPS），以JSON的形式向客户端返回数据。

调用接口时，需要输入具体接口的URL。URL都需要传入以下参数，其他的URL参数请参见每个接口的URL参数说明。

表3 URL参数
参数名	是否必选	参数说明	取值要求
device_ip	必选	登录设备的IP地址。	IPv4或IPv6地址。

本文档涉及到的请求头参数说明如下。

表4 请求头
参数名	是否必选	参数说明	取值要求
X-Auth-Token	必选	请求消息的鉴权参数。	可通过/redfish/v1/SessionService/Sessions创建会话时获得。
Content-Type	必选	请求消息的格式。	支持的消息格式包括： application/json application/json;charset=utf-8 multipart/form-data：部分以表单形式上传文件的接口，需要选择该格式
AutoRefresh	可选	用于更新会话超时起始记录时间。	字符类型，取值为“true”或者“false”。为“true”时不会更新会话超时起始记录时间，为“false”时会更新会话超时起始记录时间为当前系统运行时间的时间戳。说明：不传此参数时默认为“true”。

HTTPS协议规定，请求头字段名称不区分大小写，例如AutoRefresh和autorefresh实际效果一致，本文中涉及到的所有HTTPS请求头字段均符合此要求。

父主题： RESTful接口