Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › objet comp › Méthode list (objet comp)

Méthode list (objet comp)

Description

Récupérer la liste des composants d'application

Syntaxe

/api/v2/comp/list?app=application&vdc=nom_contrôleur 

Arguments

app

Nom de l'application

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Pour récupérer la liste des composants de l'application test :

GET http://192.168.123.200/api/v2/comp/list?app=test&vdc=mygrid 

Exemple de sortie

XML

<application>
   <name>sugarcrm</name>
   <components>
       <component>
         <name>main.admin</name>
         <bw>50000000</bw>
         <cpu>0.05</cpu>
         <mem>67108864</mem>
         <server>srv2</server>
         <state>running</state>
      </component>
      <component>
          <name>main.config</name>
         <bw>150000000</bw>
          <cpu>0.20</cpu>
         <mem>268435456</mem>
          <server>srv3</server>
         <state>running</state>
      </component>
      <component>
         <name>main.dbase</name>
         <bw>100000000</bw>
         <cpu>0.40</cpu>
         <mem>536870912</mem>
         <server>srv1</server>
         <state>running</state>
      </component>
         .
         .
         .
   </components>
</application>

JSON

{
   "component" : [
       {
         "bw" : "50000000",
   nbsp;     "cpu" : "0.05",
         "name" : "main.admin",
         "mem" : "67108864",
         "server" : "srv2",
         "state" : "running"
       },
      {
   
      "bw" : "150000000",
         "cpu" : "0,20",
         "name" : "main.config",
         "mem" : "268435456",
         "server" : "srv3",
         "state" : "running"
       },
      {
         "bw" : "100000000",
         "cpu" : "0,40",
         "name" : "main.dbase",
         "mem" : "536870912",
         "server" : "srv1",
         "state" : "running"
       },
      .
      .
      .
   ],
   "name" : "sugarcrm"
} 

Codes d'erreur HTTP

404

L'entité vdc mygrid est introuvable - Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (app). - La requête ne contient pas l'argument app=application.

404.1

Echec de l'énumération des composants pour l'application test, car elle n'est pas installée. - Le nom d'application spécifié dans la requête n'est pas valide.

404.1

Echec de l'énumération des composants de l'application 'ws_api' - échec de l'obtention des informations. Vérifiez que l'application est en cours d'exécution. La liste de composants est demandée pour une application qui est à l'arrêt.