Ressources et propriétés
Cette section décrit les ressources et les propriétés des interfaces REST basées sur les fichiers de schéma standard DMTF et les fichiers de schéma OEM fournis par Lenovo. Dans la sous-section Récapitulatif des ressources, cela permet de répertorier le nombre de ressources, le chemin d’accès à la ressource et le fichier de schéma référencé. Une autre sous-section Valeurs de propriété fournit la définition de chaque URI, y compris les valeurs de propriété, les actions et autres opérations REST.
Si REST rencontre une erreur et ne peut pas terminer la demande, le message « 500 Erreur interne du serveur » est renvoyé.
Lorsque la réponse n’est pas prête après avoir reçu une demande pendant plus de 120 secondes, REST renvoie « 503 Service temporairement indisponible ».
Si plusieurs demandes mènent aux mêmes ressources de schéma, elles sont traitées l’une après l’autre, c’est-à-dire, la deuxième requête est traitée après la première requête. Par exemple, si deux demandes mènent aux ressources MetricReport, la première demande accède aux PowerMetrics et la seconde demande accède au CPUTemp. La demande qui mène vers CPUTemp attend que la demande vers PowerMetrics soit terminée. Dans ce cas, le temps de réponse de CPUTemp est supérieure à une seule demande menant vers CPUTemp.
PATCH
Pour la mise à jour REST (PATCH), REST vérifiera d’abord si toutes les propriétés/valeurs d’entrée correspondent à la définition du schéma. S’il y a une propriété/valeur d’entrée qui est incorrecte, REST n’effectuera aucune mise à jour et renverra une erreur (400 demande incorrecte). Si l’une des propriétés d’entrée est en lecture seule ou n’est pas mise en œuvre, la valeur de cette propriété ne sera pas modifiée. Si une valeur de propriété nécessite une validation supplémentaire, plus de détails sont décrits dans la colonne « Commentaire » de la propriété. Dans le cas contraire, elle est directement transmise à la source de données. REST renvoie directement une erreur en cas d’échec de la mise à jour de la source de données. Si des erreurs se produisent pendant les opérations, REST n’annulera pas les mises à jour qui ont déjà été effectuées.
ERREUR dans le corps PATCH | Code d’état HTTP | Identifiant du message (base) | Commentaire |
Vide | 400 (demande incorrecte) | EmptyJSON | |
Format JSON incorrect | 400 (demande incorrecte) | MalformedJSON | |
Uniquement les propriétés inconnues | 400 (demande incorrecte) | PropertyUnknown | |
Type de valeur non valide | 400 (demande incorrecte) | PropertyValueTypeError | |
Plage/format de valeurs non valide | 400 (demande incorrecte) | PropertyValueFormatError | |
Valeur d’énumération non valide | 400 (demande incorrecte) | PropertyValueNotInList | |
Propriétés en lecture seule ou non mises en œuvre uniquement | 400 (demande incorrecte) | PropertyNotWritable | |
Propriétés accessibles en écriture valides avec des propriétés en lecture seule ou non mises en œuvre | 200 (OK) | PropertyNotWritable | ExtendedInfo sera ajouté pour les propriétés en lecture seule dans la réponse. |
Propriétés inscriptibles valides avec des propriétés inconnues | 200 (OK) | PropertyUnknown | ExtendedInfo sera ajouté pour les propriétés inconnues dans la réponse. |
Aucune erreur de contenu | 500 (erreur interne du serveur) | GeneralError | Par exemple, échec d’un appel d’API. |
Annotation Odata | Ceci est ignoré. Les propriétés qui correspondent au modèle « @odata », sont également traitées comme une annotation Odata. | ||
Annotation Odata uniquement | 400 (demande incorrecte) | ExtendedInfo sera ajouté pour NoOperation dans la réponse. |
Ensemble
Toutes les ressources d’ensembles mises en œuvre et leurs propriétés doivent être conformes à DSP 0266 et au schéma d’ensemble, par exemple, leurs URI doivent être conformes au « Redfish.Uris » du schéma CSDL. Dans ce document, toutes les ressources d’ensemble mises en œuvre ne sont pas décrites, sauf si la ressource d’ensemble mise en œuvre nécessite des commentaires.
Si l’utilisateur souhaite accéder à une ressource membre de l’ensemble, il doit d’abord accéder à sa ressource d’ensemble pour vérifier si la ressource existe ou non. Dans le cas contraire, la ressource n’est pas accessible ou les données de la ressource risquent d’être non valides.
Propriétés d’annotation Odata
Toutes les propriétés d’annotation Odata mises en œuvre doivent être conformes à la DSP 0266. Dans ce document, toutes les propriétés d’annotation Odata mises en œuvre ne sont pas décrites spécifiquement, sauf si la propriété mise en œuvre nécessite des commentaires supplémentaires.