虚拟机云主机管理系统API对接文档支持慧琳whmcsperimer

/json/ 返回json格式对象

不需要验证的 接口userLogin

说明:前台用户登录,由于有访问限制,请务必提交客户端ip参数:agent_ip:客户端ipuser_name:用户名passwo rd:密码

结果:

成功:status :succes svalue:id:用户idapikey :操作密钥

失败:status :failedinfo:Auth_f ailedregUse r

说明:前台用户注册

参数:realname:真实姓名email:emai l地址pwd:密码compan y_name :公司名jobs:职位

结果:

成功:status :succes svalue:id:用户idapikey :操作密钥

失败:status :failedinfo:Email_ExistsauthAd min

说明:后台管理员登录

参数:admin_name:管理员名passwo rd:管理员密码

结果:

成功:status:succes svalue:admin_id:管理员i dapikey :操作密钥priv_list:权限列表

失败:status :failedinfo: Auth_failed

resetPass

说明:重置密码管理员可调

参数:emai l: emai loldpwd:原密码newpwd :新密码

结果:

成功:status:successvalue:True

失败:status :failedinfo:ErrordoVNCConnect

说明:请求一个we bvnc连接

参数:vm_id:虚拟机id

结果:

成功:status:successvalue:端口

失败:status :failedinfo: vmid_invalidinfo: Resource_Halted

需要验证的接 口(管理员和用户 都可调用)凡是此接口参数都必须带上 apikey  如果 apik ey验证失败  会返回 status:failed, info:Error_ApiKey

UserInfo

说明:获取用户信息

参数:apikey :client_ip:user_id:用户id

结果:

成功:status:succes svalue:id: idemai l:emai l地址realname:真实姓名jobs:工作compan y_name :工作单位lastlogintime:上次登录时间regist e_time :注册时间resourceList

说明:获取指定资源池或者所有资源池列表

参数:apikey :client_ip:location_id:资源池id(可选)location_name:资源池名(可选)

结果:

成功:status:succes svalue:

列表location_id:资源池idlocation_name:资源池名type:线路类型(仅管理员可见)uname:资源池用户名仅(管理员可见)passwd :资源池密码(仅管理员可见)ip:资源池接口(仅管理员可见)失败:status :failedinfo: Error_IdcreateVm

说明:创建虚拟机

参数:apikey :vm_name:虚拟机名

config_id:方案iduser_id:虚拟机所属用户idclient_ip:客户端ip(操作记录用)image_name:模版名rid:资源池id

返回:

成功:status :succes svalue: 1

失败status :failedinfo: Resouce_HaltedimageList

说明:获取指定资源池上的模版镜像列表或者指定模版镜像参数:apikey :rid:资源池idfilename:模版镜像名(可选如果包括则返回单个值)结果:

成功:status :succes svalue:

[如果参数包括filename则是列表反之是字典]name:模版名desc:模版描述version: (系统自动生成的一个版本号)enable:可用状态template:基于何种操作系统username:系统用户名password:系统密码port:系统远程连接端口

失败:status :failedinfo: rid_invalid 资源池不存在info: Resource_halted 资源池暂不可用getVmInfo

说明:获取虚拟机信息

参数:apikey :client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机

结果:

成功:status :succesvalue:state:虚拟机状态[RUNNING(运行中) ,HALTED(关机),BUILDING(创建中) ,EXCEPT(异常,造成此状态的原因可能是网络中断或者节点服务中断) ]lblvmmemory:虚拟机内存(单位M)lblvmcpu:虚拟机cpu个数address:虚拟机ipdisk:虚拟机硬盘大小(单位G)vnc_password:虚拟机vnc密码lock:虚拟机锁定状态computer_ip:所在计算节点的iplblvmname:虚拟机名lblvmuuid:虚拟机idcontrol_ip:虚拟机所在主控ipuuid:虚拟机uui d标识

失败:status :failedinfo: Error_User_Vm(不存在的虚拟机)vmAction

说明:虚拟机操作

参数:apikey :vm_id:虚拟机/模版虚拟机i daction:虚拟机操作[startup开机, shutdown关机,delete删除用户虚拟机, lock锁定,unlock解除锁定, deltemplate删除模版虚拟机]is_template:是否为模版虚拟机client_ip:客户端ip(操作记录用)

结果:

成功:status:succes svalue:任务id

失败:status :failedvalue: vmid_invalid(虚拟机id不存在)value: Resource_Halted(资源池暂不中用)addDisk

说明:为虚拟机添加硬盘

参数:apikey :client_ip:

vm_id:虚拟机iddisk:添加大小(不带单位,单位G)

结果:

成功:status:successvalue: 1

结果:status: failedinfo: Resource_Halted

ge tVmPerf

说明:获取虚拟机的性能数据

参数:apikey :vm_id:虚拟机idperiod:周期(分钟)

结果:

成功:status: successvalue:cpu,memory,vif,disk的r rd数据失败:status :failedinfo: Resource_HalteduserVmList

说明:获取用户所有的虚拟机

参数:apikey :

结果:

成功:status:successvalue:vm_id:虚拟机idvm_name:虚拟机名vm_uuid:虚拟机uui d标识

失败:status :failedinfo: ErrorupdateVmConf ig

说明:升级虚拟机配置

参数:apikey:vm_id:虚拟机id

config_id:配置client_ip:客户端ip(记录操作日志用)

结果:

成功:status: successvalue: 1

失败:status:failedinfo: vmid_invalid (虚拟机不存在)info: configid_invalid (配置不存在)info: Resource_Halted (资源池服务暂不可用)getVmNetwork

说明:获取虚拟机的网络详细信息

参数:apikey :client_ip:vm_id:虚拟机id

结果:

成功:status :succes svalue:

[网卡列表]device:挂载设备

MAC:mac地址limit:网速限制network:ip: ip地址attached:是否挂载vif_uuid:网卡uuid标识

失败:status: failedinfo: Resource_HaltedgetVmStorage

说明:获取虚拟机的硬盘详细信息

参数:apikey :vm_id:虚拟机idclient_ip:

结果:

成功:status :succes svalue:

[硬盘列表]name_label:硬盘名description:硬盘描述sr_name:storag e名device:挂载设备disksize:硬盘大小mode:读写属性attached:挂载状态path:挂载路径bootable:是否可启动失败:status: failedinfo: Resource_Halted

listAllBack

说明:获取虚拟机的快照列表

参数:apikey :vm_id:虚拟机idclient_ip:

结果:

成功:status:succes svalue:

[快照列表]uuid:快照uuid标识name_label:快照名time:创建时间size:快照大小

失败:status :failedinfo: resource_HalteddelBack

说明:删除快照

参数:apikey :client_ipvm_id:虚拟机名snapshotname:快照名snapshotuuid:快照uuid标识结果:

成功:status :succes s

value: 1

失败:status :failedinfo: Resource_Halted

createBack

说明:创建快照

参数:apikey :client_ip:vm_id:虚拟机名snapshotname:快照名

结果:

成功:status :succes svalue:任务id

失败:status :failedinfo: Resource_HaltedrecoveryBack

说明:恢复快照

参数:apikey :client_ip:vm_id:虚拟机名snapshotname:快照名snapshotuuid:快照uuid标识结果:

成功:status :succes svalue:任务id

失败:status :failedinfo: Resource_HaltedmountISO

说明:挂载iso

参数:apikey :client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机isoname: iso名