Ressourcen und Eigenschaften
In diesem Abschnitt werden die Ressourcen und Eigenschaften von REST-Schnittstellen beschrieben, die auf den von Lenovo bereitgestellten DMTF-Standardschemadateien und OEM-Schemadateien basieren. Im Unterabschnitt zur Ressourcenzusammenfassung werden die Anzahl der Ressourcen, der Ressourcenpfad und die referenzierte Schemadatei aufgeführt. Ein weiterer Unterabschnitt für Eigenschaftswerte liefert die Definition jedes URI, einschließlich Eigenschaftswerten, Aktionen und anderen REST-Vorgängen.
Wenn bei REST ein Fehler auftritt und die Anforderung nicht abgeschlossen werden kann, wird „500 Interner Serverfehler“ zurückgegeben.
Wenn die Antwort nach dem Eingang einer Anforderung vor mehr als 120 Sekunden nicht bereit ist, gibt REST „503 Dienst vorübergehend nicht verfügbar“ zurück.
Wenn es mehr als eine Anforderung an dieselben Schemaressourcen gibt, werden diese nacheinander bearbeitet, d. h. die zweite Anforderung wird bearbeitet, nachdem die erste Anforderung abgeschlossen ist. Wenn es z. B. zwei Anforderungen an die MetricReport-Ressourcen gibt, wobei die erste Anforderung auf PowerMetrics und die zweite auf CPUTemp zugreift, wartet die Anforderung an CPUTemp, bis die Anforderung an PowerMetrics abgeschlossen ist, sodass die Antwortzeit von CPUTemp in diesem Fall länger ist als nur eine Anforderung an CPUTemp.
PATCH
Bei der REST-Aktualisierung (PATCH) prüft REST zunächst, ob alle Eingabeeigenschaften/-werte mit der Schemadefinition übereinstimmen. Wenn eine Eingabeeigenschaft oder ein Eigenschaftswert falsch ist, führt REST keine Aktualisierung durch und gibt einen Fehler (400 Ungültige Anforderung) zurück. Wenn eine der Eingabeeigenschaft schreibgeschützt oder nicht implementiert ist, wird der Wert dieser Eigenschaft nicht geändert. Für einen Eigenschaftswert, der eine weitere Validierung erfordert, sind weitere Einzelheiten in der Spalte „Kommentar“ für die Eigenschaft beschrieben. Andernfalls wird er direkt an die Datenquelle übergeben. REST gibt direkt einen Fehler zurück, wenn die Datenquelle nicht aktualisiert werden kann. Wenn während der Vorgänge Fehler auftreten, macht REST bereits vorgenommene Aktualisierungen nicht rückgängig.
PATCH-Inhalt FEHLER | HTTP-Statuscode | Nachrichten-ID (Basis) | Kommentar |
Leer | 400 (Ungültige Anforderung) | EmptyJSON | |
Falsches JSON-Format | 400 (Ungültige Anforderung) | MalformedJSON | |
Nur unbekannte Eigenschaften | 400 (Ungültige Anforderung) | PropertyUnknown | |
Ungültiger Werttyp | 400 (Ungültige Anforderung) | PropertyValueTypeError | |
Ungültiger Wertebereich/ungültiges Format | 400 (Ungültige Anforderung) | PropertyValueFormatError | |
Ungültiger Enumerationswert | 400 (Ungültige Anforderung) | PropertyValueNotInList | |
Nur schreibgeschützte oder nicht implementierte Eigenschaften | 400 (Ungültige Anforderung) | PropertyNotWritable | |
Gültige beschreibbare Eigenschaften zusammen mit schreibgeschützten oder nicht implementierten Eigenschaften | 200 (OK) | PropertyNotWritable | ExtendedInfo wird für schreibgeschützte Eigenschaften in der Antwort hinzugefügt. |
Gültige beschreibbare Eigenschaften zusammen mit unbekannten Eigenschaften | 200 (OK) | PropertyUnknown | ExtendedInfo wird für unbekannte Eigenschaften in der Antwort hinzugefügt. |
Kein Inhaltsfehler | 500 (Interner Serverfehler) | GeneralError | Beispiel: API-Aufruffehler. |
Odata-Annotation | Dies wird ignoriert. Jede Eigenschaft, die dem Muster „@odata“ entspricht, wird auch als Odata-Annotation behandelt. | ||
Nur Odata-Annotation | 400 (Ungültige Anforderung) | ExtendedInfo wird für NoOperation in der Antwort hinzugefügt. |
Sammlung
Alle implementierten Collection-Ressourcen und ihre Eigenschaften müssen dem DSP 0266 und dem Collection-Schema entsprechen, z. B. müssen ihre URIs den „Redfish.Uris“ des CSDL-Schemas entsprechen. In diesem Dokument werden nicht alle implementierten Sammlungsressourcen beschrieben, es sei denn, die implementierte Sammlungsressource erfordert Kommentare.
Wenn der Benutzer auf eine Ressource, die Mitglied einer Sammlung ist, zugreifen möchte, muss er zuerst die Sammlungsressource aufrufen, um zu überprüfen, ob die Ressource vorhanden ist oder nicht. Andernfalls kann nicht auf die Ressource zugegriffen werden, oder die Daten der Ressource können ungültig sein.
Odata-Annotationseigenschaften
Alle implementierten Odata-Annotationseigenschaften müssen dem DSP 0266 entsprechen. In diesem Dokument werden alle implementierten Odata-Annotationseigenschaften nicht speziell beschrieben, es sei denn, die implementierte Eigenschaft erfordert zusätzliche Kommentare.