HP OneView - Manuel (Page 63)

5.6 Version d'API REST
Lorsque vous effectuez une opération d'API REST, un en-tête X-API-Version est nécessaire. Cet
en-tête de version correspond à la version d'API REST du logiciel actuellement exécuté sur l'appareil.
Pour déterminer la version d'API REST correcte, exécutez /rest/version. Cette opération GET
ne nécessite pas un en-tête X-API-Version. Si plusieurs appareils sont exécutés dans votre
environnement, vous devez déterminer la version d'API REST requise par chaque appareil.
L'en-tête X-API-Version pour cette version de HP OneView doit toujours être 3
(X-API-Version:3).
5.7 Opérations asynchrones et opérations synchrones
Une tâche synchrone renvoie une réponse après l'opération d'API REST. Par exemple, POST
/rest/server-profiles
retourne un profil de serveur nouvellement créé dans le corps de
réponse. Une tâche asynchrone, comme la création d'une sauvegarde de l'appareil, retourne l'URI
d'un modèle de ressource TaskResource. Vous pouvez utiliser l'URI de modèle de ressource
TaskResource
pour répertorier l'état actuel de l'opération.
5.8 Ressource de tâche
Lorsque vous effectuez une opération d'API REST asynchrone, l'état HTTP 202 Accepted est
retourné et l'URI d'un modèle de ressource TaskResource est renvoyé dans l'en-tête Location
de la réponse.
Vous pouvez ensuite effectuer une opération GET sur l'URI de modèle TaskResource pour scruter
l'état de l'opération asynchrone. Le modèle TaskResource contient également le nom et l'URI
de la ressource qui est affectée par la tâche dans l'attribut associatedResource.
Création d'un exemple de sauvegarde de l'appareil
1. Créez une sauvegarde de l'appareil.
/rest/backups
L'URI d'un paramètre TaskResource dans l'en-tête Location est retourné dans la réponse.
2. Scrutez l'état de la sauvegarde en utilisant l'URI TaskResource retourné dans l'étape 1.
/rest/tasks/{id}
3. Lorsque la tâche atteint l'état Completed, utilisez l'URI associatedResource dans le paramètre TaskResource
pour télécharger le fichier de sauvegarde.
GET {associatedResource URI}
5.9 Traitement des erreurs
Si une erreur se produit lors d'une opération d'API REST, une erreur 4xx (côté client) ou 5xx
(appareil) est retournée avec un message d'erreur (ErrorMessage modèle de ressource). Le
message d'erreur contient une description et peut contenir des mesures recommandées pour corriger
l'erreur.
Une opération d'API REST POST réussie retourne la ressource nouvellement créée (synchrone) ou
un URI TaskResource dans l'en-tête Location (asynchrone).
5.10 Contrôle de concurrence à l'aide d'etags
Un client utilise des etags pour vérifier la version du modèle de ressource. Cela empêche le client
de modifier (PUT) une version du modèle de ressource qui n'est pas à jour. Par exemple, si un
client effectue une opération GET sur un profil de serveur et reçoit une etag dans l'en-tête de
réponse, modifie le profil de serveur, puis met à jour (PUT) le modèle de ressource, l'etag dans
l'en-tête de demande PUT doit correspondre à l'etag du modèle de ressource. Si les etags ne
5.6 Version d'API REST 63