RESTful接口
OM SDK提供标准的RESTful接口供开发者进行查看或者调用；支持开发者进行硬件基础管理功能的二次开发或集成。
Redfish是一种基于HTTPS服务的管理标准，利用RESTful接口实现设备管理。每个HTTPS操作都以UTF-8编码的JSON的形式，提交或返回一个资源。就像Web应用程序向浏览器返回HTML一样，RESTful接口会通过同样的传输机制（HTTPS），以JSON的形式向客户端返回数据。
资源操作
操作 |
说明 |
|---|---|
GET资源URI |
返回所请求的资源描述。 |
POST资源URI |
创建新资源或执行指定资源的方法。 |
PATCH资源URI |
修改当前资源属性。 |
DELETE资源URI |
删除指定资源。 |
返回状态码
状态码 |
说明 |
|---|---|
200 |
请求成功。 |
201 |
资源成功创建。 |
202 |
创建任务执行成功。 |
206 |
部分成功。 |
400 |
请求非法，客户端侧发生错误并返回错误消息。 |
401 |
无效的用户请求。 |
403 |
服务端拒绝请求。 |
404 |
访问请求资源不存在。 |
405 |
不支持的操作。 |
409 |
请求资源的状态之间存在冲突。 |
413 |
请求实体过大。 |
500 |
服务端内部错误。 |
501 |
所请求的功能当前尚未实现。 |
502 |
网关错误。 |
503 |
服务不可用。 |
504 |
网关超时。 |
URL参数
调用接口时，需要输入具体接口的URL。URL都需要传入以下参数，其他的URL参数请参见每个接口的URL参数说明。
参数名 |
是否必选 |
参数说明 |
取值要求 |
|---|---|---|---|
device_ip |
必选 |
登录设备的IP地址。 |
IPv4或IPv6地址。 |
请求头参数
本文档涉及到的请求头参数说明如下。
参数名 |
是否必选 |
参数说明 |
取值要求 |
|---|---|---|---|
X-Auth-Token |
必选 |
请求消息的鉴权参数。 |
可通过/redfish/v1/SessionService/Sessions创建会话时获得。 |
Content-Type |
必选 |
请求消息的格式。 |
支持的消息格式包括：
|
AutoRefresh |
可选 |
用于更新会话超时起始记录时间。 |
字符类型，取值为“true”或者“false”。为“true”时不会更新会话超时起始记录时间，为“false”时会更新会话超时起始记录时间为当前系统运行时间的时间戳。
说明：
不传此参数时默认为“true”。 |
HTTPS协议规定，请求头字段名称不区分大小写，例如AutoRefresh和autorefresh实际效果一致，本文中涉及到的所有HTTPS请求头字段均符合此要求。
