リソースおよびプロパティー
このセクションでは、Lenovo が提供する DMTF 標準スキーマ・ファイルおよび OEM スキーマ・ファイルに基づく REST インターフェースのリソースとプロパティーについて説明します。「リソースの概要」サブセクションには、リソースの数、リソース・パス、および参照されるスキーマ・ファイルがリストされます。別のサブセクション「プロパティー値」で、各 URI の定義を示します。これにはプロパティー値、アクション、およびその他の REST 操作が含まれます。
REST でエラーが発生し、要求を完了できない場合は、「500 Internal Server Error」が返されます。
要求を 120 秒以上受信した後で応答の準備ができていない場合、REST は「503 サービスが一時的に利用できません」を返します。
同じスキーマ・リソースへの要求が複数ある場合は、1 つずつ処理され、最初の要求が完了した後に 2 番目のリクエストが処理されます。たとえば、MetricReport リソースに対する要求が 2 つあり、最初の要求が PowerMetrics にアクセスし、2 番目の要求が CPUTemp にアクセスする場合、CPUTemp への要求は PowerMetrics への要求が行われるのを待つため、この場合の CPUTemp の応答時間は CPUTemp への 1 つの要求よりも長くなります。
PATCH
REST 更新 (PATCH) の場合、REST はまず、すべての入力プロパティー/値がスキーマ定義と一致するかどうかを確認します。正しくない入力プロパティー/値がある場合、REST は更新を行わず、エラー(400 不正な要求) を返します。入力プロパティのいずれかが読み取り専用であるか、実装されていない場合、このプロパティの値は変更されません。あるプロパティー値がさらに検証を必要とする場合は、プロパティーの「コメント」列に詳細が記載され、それ以外の場合はデータ・ソースに直接渡されます。REST は、データソースの更新に失敗した場合、エラーを直接返します。操作中にエラーが発生した場合、REST は既に行われた更新を元に戻しません。
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 (不正な要求) | ExtendedInfo は応答の NoOperation に追加されます。 |
コレクション
実装されたすべてのコレクション・リソースとそのプロパティーは DSP 0266 に準拠し、コレクション・スキーマ (URI など) は CSDL スキーマの「Redfish.Uris」に準拠する必要があります。このドキュメントでは、実装されたコレクション・リソースにコメントが必要でない限り、実装されたすべてのコレクション・リソースについては説明しません。
ユーザーがコレクション・メンバー・リソースにアクセスする場合、ユーザーはまずそのコレクション・リソースにアクセスして、リソースが存在するかどうかを確認する必要があります。そうしないと、リソースにアクセスできないか、リソースのデータが無効になる可能性があります。
Odata アノテーション・プロパティ
実装されたすべての Odata アノテーション・プロパティは、DSP 0266 に準拠する必要があります。このドキュメントでは、実装されたプロパティに追加のコメントが必要でない限り、実装されたすべての Odata アノテーション・プロパティーについて具体的に説明しません。