集成指南 › Web 服务 API 参考指南 › 有效对象 › class 对象 › get_desc 方法（class 对象）

get_desc 方法（class 对象）

说明

显示类描述符

语法

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

参数

class

类的名称

vdc

目标虚拟数据中心的名称

事务类型

同步

请求类型

GET

示例

显示 /test:LUX5 的描述符

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

样例输出

XML：

<message>组件 LUX5 
   { 
   .category         = Generic 
   .description      = &quot;通用 Linux 组件－基于 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 
      } 
 
   可视化 
      { 
      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      = \"通用 Linux 组件－基于 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" 
}

HTTP 错误代码

404

未找到实体 vdc mygrid－WS_API 应用中没有配置指定的 VDC 名称。

400.4

缺少必需参数 (class)－缺少参数 class=class

404.1

找不到全局目录 test－指定的目录无效

404.1

找不到目录类 LUX－指定的类无效