跳到主要内容

资源和属性

本节介绍基于 Lenovo 提供的 DMTF 标准架构文件和 OEM 架构文件的 REST 接口的资源和属性。“资源摘要”小节中列出了资源数、资源路径和引用的架构文件。另一个“属性值”小节中提供了每个 URI 的定义,包括属性值、操作和其他 REST 操作。

如果 REST 遇到错误并且无法完成请求,它将返回“500 内部服务器错误”。

如果在收到请求超过 120 秒后响应未就绪,REST 将返回“503 服务暂时不可用”。

如果对同一个架构资源有多个请求,则会逐个处理,即在第一个请求完成后再处理第二个请求。例如,如果对 MetricReport 资源有两个请求,第一个请求访问 PowerMetrics,第二个请求访问 CPUTemp,则对 CPUTemp 的请求将等待对 PowerMetrics 的请求完成,因此在这种情况下,CPUTemp 的响应时间长于仅对 CPUTemp 的一个请求。

PATCH

对于 REST 更新(PATCH),REST 将首先检查所有输入属性/值是否与架构定义匹配。如果有任何输入属性/值不正确,REST 将不会执行任何更新,并将返回错误(400 错误请求)。如果任何输入属性是只读的或未实现,则不会更改此属性的值。对于需要进一步验证的一个属性值,该属性的“注释”列中介绍了更多详细信息,否则它将被直接传递到数据源。当更新数据源失败时,REST 将直接返回错误。如果在操作过程中发生任何错误,REST 将不会恢复已完成的更新。

下面是 HTTP 状态代码和消息 ID 的错误映射表:

PATCH 正文错误

HTTP 状态代码

Messageld(基本)

注释

400(错误请求)

EmptyJSON

 

Json 格式错误

400(错误请求)

MalformedJSON

 

只有未知属性

400(错误请求)

PropertyUnknown

 

值类型无效

400(错误请求)

PropertyValueTypeError

 

值范围/格式无效

400(错误请求)

PropertyValueFormatError

 

枚举值无效

400(错误请求)

PropertyValueNotInList

 

只有只读或未实现的属性

400(错误请求)

PropertyNotWritable

 

有效的可写属性与只读或未实现的属性并存

200 (OK)

PropertyNotWritable

在响应中将为只读属性添加 ExtendedInfo

有效的可写属性与未知属性并存

200 (OK)

PropertyUnknown

在响应中将为未知属性添加 ExtendedInfo

无内容错误

500(内部服务器错误)

GeneralError

例如,API 调用失败。

Odata 注释

  

这将被忽略。任何与“@odata.”模式匹配的属性也会被视为 Odata 注释。

只有 Odata 注释

400(错误请求)

 

在响应中将为 NoOperation 添加 ExtendedInfo

当对其他资源执行 PATCH 且 HTTP 状态代码为 400 错误请求时,响应仅包括 Redfish 服务检查的第一个错误属性。

集合

所有实现的集合资源及其属性都应符合 DSP 0266 和集合架构,例如,其 URI 应符合 CSDL 架构的“Redfish.Uris”。本文档不会对所有已实现的集合资源进行说明,除非已实现的集合资源需要注释。

如果用户想要访问集合成员资源,则需要先访问其集合资源,以检查该资源是否存在。否则,将无法访问资源或资源数据可能无效。

Odata 注释属性

所有已实现的 Odata 注释属性都应符合 DSP 0266 标准。本文档中不会对所有已实现的 Odata 注释属性进行具体说明,除非已实现的属性需要额外的注释。