API VDSmanager. Information générale (VDSmanager)

De ISPWiki.

VDSmanager 4 permet d'utiliser toutes ses fonctions depuis des programmes externes qui seront situés soit localement (sur le même serveur), soit à distance (sur un autre serveur). Pour appeler une fonction d'ISPmanager il pourra être nécessaire de [auth.api s'identifier].

Sommaire

Format de sortie des résultats de l'exécution des fonctions de VDSmanager 4

VDSmanager 4 permet d'obtenir les résultats de l'exécution de ses fonctions au format XML, ou au format texte.

Sortie des résultats au format XML

Pour obtenir les données en XML il est nécessaire d'indiquer un paramètre supplémentaire out=xml dans la requête. Le résultat dépend du type de fonction que vous appelez. Si la fonction reçoit la liste des éléments elle retourne un document XML composé d'une liste des noeuds XML, l'un pour chaque élément. Chaque noeud est composé à son tour d'un ensemble de noeuds qui déterminent les paramètres d'un élément donné. Par exemple, lorsque vous vous connectez au panneau de contrôle pour obtenir la liste des Serveurs Dédiés Virtuels vous voyez à peu près la chose suivante:

# fetch -qo - "https://localhost/manager/vdsmgr?func=vds&out=xml" <?xml version="1.0" encoding="UTF-8"?> <doc> <elem> <name>example.com</name> <ip>192.168.0.14</ip> <owner>admin</owner> <disk used="0" limit="500"/> <traf used="0" limit="4096"/> <disabled/> <aliases>3</aliases> </elem> <elem> <name>foobar.net</name> <ip>192.168.0.7</ip> <owner>admin</owner> <disk used="0" limit="1024"/> <traf used="0" limit="16384"/> <aliases>0</aliases> </elem> </doc>

Lorsque vous appelez une fonction retournant l'ensemble de paramètres d'un élément, par exemple lors de son affichage ou sa modification, le panneau de contrôle retourne le document XML qui contient la liste des noeuds correspondant aux paramètres d'un élément modifié. Par exemple, lorsque vous affichez les propriétés d'un Serveur Dédié Virtuel vous voyez:

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.edit&elid=192.168.0.14&out=xml" <?xml version="1.0" encoding="UTF-8"?> <doc> <elid>192.168.0.14</elid> <name>example.com</name> <mem>64</mem> <cpu>333</cpu> <proc>768</proc> <desc>768</desc> <iprate>999</iprate> <traf>4096</traf> <disk>500</disk> </doc>

Si vous appelez une fonction qui doit effectuer une manipulation, par exemple désactiver un serveur dédié virtuel, le panneau de contrôle retournera le document XML informant de la réussite de l'opération

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.disable&elid=192.168.0.14&out=xml" <?xml version="1.0" encoding="UTF-8"?> <doc> <ok/> </doc>

ou le message d'erreur

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.disable&elid=abrakadabra&out=xml" <?xml version="1.0" encoding="UTF-8"?> <doc> <error code="3" obj="vds"/> </doc>

Sortie des résultats au format texte

Pour obtenir les données au format texte il est nécessaire d'indiquer un paramètre supplémentaire out=text dans la requête. Le résultat dépend du type de fonction que vous appelez. Si la fonction reçoit la liste des éléments elle retourne la liste des lignes, chacune desquelles correspond à un élément et est composéé d'un ensemble de paramètres de cet élément. Par exemple, lorsque vous vous connectez au panneau de contrôle pour obtenir la liste des Serveurs Dédiés Virtuels vous voyez à peu près la chose suivante:

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds&out=text" name=example.com ip=192.168.0.14 owner=admin disk=1/500 traf=0/4096 disabled aliases=3 name=foobar.net ip=192.168.0.07 owner=admin disk=1/1024 traf=0/16384 aliases=0

Lorsque vous appelez une fonction retournant l'ensemble de paramètres d'un élément, par exemple lors de son affichage ou sa modification, le panneau de contrôle retourne la liste des paramètres de l'élément, l'un pour chaque ligne. Par exemple, lorsque vous affichez les propriétés d'un Serveur Dédié Virtuel vous voyez:

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.edit&elid=192.168.0.14&out=text" elid=82.146.63.190 name=example.com mem=64 cpu=333 proc=768 desc=768 iprate=999 traf=4096 disk=500

Si vous appelez une fonction qui doit effectuer une manipulation, par exemple désactiver un serveur dédié virtuel, en cas de réussite de l'opération le panneau de contrôle retournera

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.disable&elid=192.146.0.14&out=text" OK

ou le message d'erreur

# fetch -qo - "https://127.0.0.1/manager/vdsmgr?func=vds.disable&elid=abrakadabra&out=text" ERROR: message d'erreur

Description des fonctions VDSmanager

La description des fonctions VDSmanager est la suivante:

Fonction: un nom de fonction, qu'il est nécessaire de spécifier dans le paramètre func de la requête.

Paramètres: la liste des paramètres avec une brève description. Si la fonction n'accepte aucuns paramètres, ils ne figurent dans la description. Les paramètres sont transmis au format paramètre=valeur.

Résultat: il existe quelques types de résultats, cela dépend du type d'une fonction requise:

  • Liste des éléments (tableau).
  • Liste des paramètres d'un objet (formulaire).
  • Réussite de l'opération (opération).
  • Message d'erreur.

Ci-dessous nous envisageons chacun de ces types de résultat avec description et des exemples. Tous les exemples sont présentés au format XML.

Liste des éléments (tableau)

Dans ce cas le document XML est le suivant:

<?xml version="1.0" encoding="UTF-8"?> <doc> <elem>paramètres d'un élément dans la liste</elem> <elem>paramètres d'un élément dans la liste</elem> ... <elem>paramètres d'un élément dans la liste</elem> </doc>

Nous n'envisageons que les paramètres d'un élément dans la liste qui représentent un ou plusieurs noeuds XML avec des attributs et valeurs possibles car tout le reste est identique pour tous les listes des éléments. Exemple:

<?xml version="1.0" encoding="UTF-8"?> <doc> <elem> <name>example.com</name> <ip>192.168.0.14</ip> <owner>admin</owner> <disk used="0" limit="500"/> <traf used="0" limit="4096"/> <disabled/> <aliases>3</aliases> </elem> <elem> <name>foobar.net</name> <ip>192.168.0.7</ip> <owner>admin</owner> <disk used="0" limit="1024"/> <traf used="0" limit="16384"/> <aliases>0</aliases> </elem> </doc>

Liste des paramètres d'un objet (formulaire)

Dans ce cas le document XML est le suivant:

<?xml version="1.0" encoding="UTF-8"?> <doc> <elid>identificateur unique d'un objet</elid> paramètres d'un objet </doc>

Nous n'envisageons que les paramètres d'un objet qui représentent un ou plusieurs noeuds XML avec des attributs et valeurs possibles décrivant les propriétés de cet objet. Tout le reste est identique pour tous les listes des éléments. Exemple:

<?xml version="1.0" encoding="UTF-8"?> <doc> <elid>192.168.0.14</elid> <name>example.com</name> <mem>64</mem> <cpu>333</cpu> <proc>768</proc> <desc>768</desc> <iprate>999</iprate> <traf>4096</traf> <disk>500</disk> </doc>

Réussite de l'opération (opération)

Ce résultat est obtenu lors de la création, modification, suppression, activation ou désactivation d'un objet. Dans ce cas le document XML est le suivant:

<?xml version="1.0" encoding="UTF-8"?> <doc> <ok/> </doc>

Message d'erreur

Ce résultat est obtenu lors de l'apparition d'une erreur au cours du traitement de votre requête. Dans ce cas le document XML est le suivant:

<?xml version="1.0" encoding="UTF-8"?> <doc> <error>message d'erreur.</error> </doc>

Cet article vous a-t-il été utile? Oui | Non
Affichages
Outils personnels