servermodel.describe

Retourne les attributs détaillées d’un modèle de serveur

Exemple d’utilisation via l’API HTTP

curl -v -X 'POST' -d '{"kwargs":{"ServerModelId":1,"inheritance":false}}' http://localhost:30005/api/v1/servermodel.describe
Type de message:
 rpc
Utilisable via l’API Gateway:
 oui
Domaine fonctionnel:
 server-model-domain

Paramètres nommés

ServerModelId
Description:Identifiant du modèle de serveur à récupérer
Type:Integer
Requis:oui
inheritance
Description:La réponse doit elle inclure les données héritées des modèles de serveur parents ?
Type:Boolean
Requis:non

Réponse

Paramètres nommés

services
Description:Liste des services applicatifs déclarés pour ce modèle de serveur
Type:Array[Object]
model
Description:Modèle de serveur avec ses attributs détaillés
Type:Object

Erreurs

servermodel.describe.error.database_not_available

Erreur retournée lorsque la base de données n’est pas disponible.

Paramètres nommés

reason
Description:Description supplémentaire des causes de l’erreur
Type:String

servermodel.describe.error.invalid_servermodel_id

L’argument ServerModelId fourni n’est pas du type Integer

Paramètres nommés

reason
Description:Description supplémentaire des causes de l’erreur
Type:String

servermodel.describe.error.unknown_servermodel_id

L’identifiant ServerModelId ne correspond a aucun enregistrement dans la base.

Paramètres nommés

reason
Description:Description supplémentaire des causes de l’erreur
Type:String