2 codes de retour, 3 format du uri, 4 format de modèle de ressource – HP OneView Manuel d'utilisation

Page 62: 5 connexion à l'appareil à l'aide d'api rest, Codes de retour, Format du uri, Format de modèle de ressource, Connexion à l'appareil à l'aide d'api rest

Advertising
background image

5.2 Codes de retour

Description

Code de retour

Opération réussie

2xx

Erreur côté client avec un message d'erreur renvoyé

4xx

Erreur de l'Appliance avec un message d'erreur renvoyé

5xx

REMARQUE :

Si une erreur se produit, indiquée par un code de retour 4xx ou 5xx, un

ErrorMessage

est renvoyé. Le modèle de ressource attendu n'est pas renvoyé.

5.3 Format du URI

Tous les URI pointent vers des ressources. Le client n'a pas besoin de créer ou modifier des URI.
L'URI d'une ressource est statique et utilise le format
https://{appl}/rest/catégorie_ressource/ID_ressource

où :

https://{appl}

Adresse de l'appareil

/rest

Type de URI.

/catégorie_ressource

Catégorie de la ressource (par exemple, server-profiles)

/ID_instance_ressource

Identifiant de l'instance de ressource spécifique (facultatif)

5.4 Format de modèle de ressource

Les ressources prennent en charge le format JSON (JavaScript Object Notation) pour l'échange
de données à l'aide d'une API REST. Sauf indication contraire dans l'opération de l'API REST, le
format par défaut est JSON.

5.5 Connexion à l'appareil à l'aide d'API REST

Lorsque vous vous connectez à l'appareil à l'aide de l'API REST login-sessions, un ID de
session est renvoyé. Vous utilisez l'ID de session dans toutes les opérations de l'API REST suivantes
dans l'en-tête auth, excepté ce qui est noté dans les En-têtes de demande d'API REST. L'ID de
session est valide pendant 24 heures.

Déconnexion

Connexion

Opération

DELETE

API

/rest/login-sessions

En-têtes de demande

auth:{YourSessionID}

En-têtes de demande d'API REST

Corps de demande

Aucun

Réponse

204 No Content

Opération

POST

API

/rest/login-sessions

En-têtes de demande

En-têtes de demande d'API REST

Corps de demande

{"userName":"YourUserName","password":"YourPassword"}

REMARQUE :

Ceci est un exemple d'un journal local sur

l'appareil. Si vous utilisez un service d'annuaire, vous devez
ajouter les attributs suivants : authnHost et
authLoginDomain

.

Réponse

La valeur LoginSessionIdDTO qui comprend l'ID de session

62

Utilisation des API REST et d'autres interfaces de programmation

Advertising