Guide di integrazione › Guida di riferimento API del servizio Web › Oggetti validi › Oggetto class › Metodo get_desc (oggetto class)

Metodo get_desc (oggetto class)

Description

Visualizza il descrittore della classe

Sintassi

/api/v2/class/get_desc?class=class&vdc=controller-name 

Argomenti

class

Nome della classe

vdc

Nome del data center virtuale di destinazione

Tipo di transazione

sincrona

Tipo di richiesta

GET

Esempi

Visualizza il descrittore per /test:LUX5

GET http://192.168.123.200/api/v2/class/get_desc?class=/test:LUX5&vdc=mygrid 

Output di esempio

XML:

<message>component LUX5 
   { 
   .category         = Generic 
   .description      = &quot;Generic Linux Appliance - based on CentOS 5.4 (v1.3.1-1)&quot; 
   .doc_url          = &quot;http://doc.3tera.com/AppLogic29/CatGenericLux.html&quot; 
   .config_mode      = dhcp 
   .migrateable      = 1 
 
   volume boot       : class               , boot           , dev  = /dev/hda1 , type = instantiable 
   volume usr        : class               , shared         , ro               , dev  = /dev/hda2    , type = common 
 
   resource cpu      : min      = 0,05     , max      = 4   , dflt = 0,05 
   resource mem      : min      = 64M      , max      = 2G  , dflt = 128M 
   resource bw       : min      = 1M       , max      = 2G  , dflt = 100M 
 
   input in          : protocol = any 
   output out        : protocol = any 
   output net        : gateway             , protocol = any 
   output mon        : protocol = cce 
 
   interface default 
 
   virtualization    : mode     = paravirt 
      { 
      console       = &quot;ssh:22,text&quot; 
      device_schema = /dev/hdaX 
      } 
 
   visual 
      { 
      color      = gray 
      style      = small 
      size       = 3 
      east       = ooo 
      west       = i 
      picture    = linux 
 
      output out : orient = east 
      input in   : orient = west 
      output mon : orient = east 
      output net : orient = east 
      } 
   } 
</message>

JSON:

{ 
   "message" : "component LUX5\n   {\n   .category         = Generic\n   .description      = \"Generic Linux Appliance - based on CentOS 5,4 (v1.3.1-1)\"\n   .doc_url          = \"http://doc.3tera.com/AppLogic29/CatGenericLux.html\"\n   .config_mode      = dhcp\n   .migrateable      = 1\n\n   volume boot       : class               , boot           , dev  = /dev/hda1 , type = instantiable\n   volume usr        : class               , shared         , ro               , dev  = /dev/hda2    , type = common\n\n   resource cpu      : min      = 0,05     , max      = 4   , dflt = 0,05\n   resource mem      : min      = 64M      , max      = 2G  , dflt = 128M\n   resource bw       : min      = 1M       , max      = 2G  , dflt = 100M\n\n   input in          : protocol = any\n   output out        : protocol = any\n   output net        : gateway             , protocol = any\n   output mon        : protocol = cce\n\n   interface default\n\n   virtualization    : mode     = paravirt\n      {\n      console       = \"ssh:22,text\"\n      device_schema = /dev/hdaX\n      }\n\n   visual\n      {\n      color      = gray\n      style      = small\n      size       = 3\n      east       = ooo\n      west       = i\n      picture    = linux\n\n      output out : orient = east\n      input in   : orient = west\n      output mon : orient = east\n      output net : orient = east\n      }\n   }\n" 
}

Codici di errore HTTP

404

Entità vdc mygrid non trovata - È stato specificato un nome di VDC non configurato nell'applicazione WS_API.

400.4

Argomenti necessari mancanti (class) - Argomento class=class mancante

404.1

Catalogo globale 'test' non trovato - Catalogo specificato non valido

404.1

Classe 'LUX' del catalogo non trovata - Classe specificata non valida