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

/json/ 返回json格式对象不需要验证的接口userLogin说明: 前台用户登录,由于有访问限制,请务必提交客户端ip参数:agent_ip:客户端ipuser_name:用户名 password:密码结果: 成功: status:success value: id:用户id apikey:操作密钥 失败: status:failed info:Auth_failedregUser说明: 前台用户注册参数: realname:真实姓名email:email地址pwd:密码company_name:公司名jobs:职位结果: 成功: status:success value: id:用户id apikey:操作密钥 失败: status:failed info:Email_ExistsauthAdmin说明: 后台管理员登录参数:admin_name:管理员名password:管理员密码结果:成功:status:successvalue:admin_id:管理员idapikey:操作密钥priv_list:权限列表失败:status:failedinfo: Auth_failedresetPass说明:重置密码，管理员可调参数:email: emailoldpwd: 原密码newpwd: 新密码结果:成功:status:successvalue:True失败:status: failedinfo:ErrordoVNCConnect说明:请求一个webvnc连接参数:vm_id: 虚拟机id结果:成功:status:successvalue:端口失败:status: failedinfo: vmid_invalidinfo: Resource_Halted需要验证的接口(管理员和用户都可调用)凡是此接口参数都必须带上apikey，如果apikey验证失败，会返回status:failed,info:Error_ApiKeyUserInfo说明:获取用户信息参数:apikey:client_ip:user_id:用户id结果:成功:status:successvalue:id:idemail:email地址realname:真实姓名jobs:工作company_name:工作单位lastlogintime:上次登录时间registe_time:注册时间resourceList说明:获取指定资源池或者所有资源池列表参数:apikey:client_ip:location_id:资源池id(可选)location_name:资源池名(可选)结果:成功:status:successvalue:列表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:successvalue:1失败：status: failedinfo: Resouce_HaltedimageList说明:获取指定资源池上的模版镜像列表或者指定模版镜像参数:apikey:rid:资源池idfilename:模版镜像名(可选，如果包括则返回单个值)结果:成功:status:successvalue:如果参数包括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:虚拟机uuid标识失败:status:failedinfo: Error_User_Vm(不存在的虚拟机)vmAction说明:虚拟机操作参数:apikey:vm_id:虚拟机/模版虚拟机idaction:虚拟机操作startup开机,shutdown关机,delete删除用户虚拟机, lock锁定, unlock解除锁定, deltemplate删除模版虚拟机is_template:是否为模版虚拟机client_ip:客户端ip(操作记录用)结果:成功:status:successvalue:任务id失败:status: failedvalue: vmid_invalid(虚拟机id不存在)value: Resource_Halted(资源池暂不中用)addDisk说明:为虚拟机添加硬盘参数:apikey:client_ip:vm_id:虚拟机iddisk:添加大小(不带单位,单位G)结果:成功:status:successvalue:1结果:status: failedinfo: Resource_HaltedgetVmPerf说明:获取虚拟机的性能数据参数:apikey:vm_id:虚拟机idperiod:周期(分钟)结果:成功:status: successvalue:cpu,memory,vif,disk的rrd数据失败:status: failedinfo: Resource_HalteduserVmList说明:获取用户所有的虚拟机参数:apikey:结果:成功:status:successvalue:vm_id:虚拟机idvm_name:虚拟机名vm_uuid:虚拟机uuid标识失败:status: failedinfo: ErrorupdateVmConfig说明:升级虚拟机配置参数:apikey:vm_id:虚拟机idconfig_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:successvalue:网卡列表device:挂载设备MAC:mac地址limit:网速限制network:ip:ip地址attached:是否挂载vif_uuid:网卡uuid标识失败:status: failedinfo: Resource_HaltedgetVmStorage说明:获取虚拟机的硬盘详细信息参数:apikey:vm_id:虚拟机idclient_ip:结果:成功:status:successvalue:硬盘列表name_label:硬盘名description:硬盘描述sr_name:storage名device:挂载设备disksize:硬盘大小mode:读写属性attached:挂载状态path:挂载路径bootable:是否可启动失败:status: failedinfo: Resource_HaltedlistAllBack说明:获取虚拟机的快照列表参数:apikey:vm_id:虚拟机idclient_ip:结果:成功:status:successvalue:快照列表uuid:快照uuid标识name_label:快照名time:创建时间size:快照大小失败:status: failedinfo: resource_HalteddelBack说明:删除快照参数:apikey:client_ip：vm_id:虚拟机名snapshotname:快照名snapshotuuid:快照uuid标识结果:成功:status:successvalue:1失败:status:failedinfo: Resource_HaltedcreateBack说明:创建快照参数:apikey:client_ip:vm_id:虚拟机名snapshotname:快照名结果:成功:status:successvalue:任务id失败:status: failedinfo: Resource_HaltedrecoveryBack说明:恢复快照参数:apikey:client_ip:vm_id:虚拟机名snapshotname:快照名snapshotuuid:快照uuid标识结果:成功:status:successvalue:任务id失败:status: failedinfo: Resource_HaltedmountISO说明:挂载iso参数:apikey:client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机isoname:iso名结果:成功:status:successvalue:1失败:status: failedinfo: Resource_HaltedunmountISO说明:弹出iso参数:apikey:client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机结果:成功:status:successvalue:1失败:status: failedinfo: Resource_HaltedgetCdrom说明:获取iso的状态参数:apikey:client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机结果:成功:status:successvalue:cdrom列表device:挂载设备uuid:uuid标识iso:当前挂载iso名attached:是否已挂载bootable:是否可启动失败:status: failedinfo: Resource_HaltedmountList说明:获取所有可挂载iso参数:apikey:client_ip:vm_id:虚拟机idis_template:是否为模版虚拟机结果:成功:status: successvalue:iso列表filename:文件名name:iso别名desc:描述version:版本号(自动生成)enable:可用状态失败:status:failedinfo: Resource_HaltedtaskInfo说明:获取任务结果参数:apikey:client_ip:taskid:任务id结果:成功:status:successvalue:task_id:任务iduser_id:任务所属用户idfun_name:操作方法params:操作参数status:任务状态start_time:起始时间end_time:完成结果task_result:结果1正在执行,2失败,3成功task_info:任务描述is_admin:是否管理员操作task_uuid:任务uuidlocaltion_id:所属资源池vm_id:所属虚拟机失败:status:failedinfo: Error_Request (非所属用户请求)info: Error_TaskId (不存在的任务id)configList说明:获取计算机配置清单参数:apikey:client_ip:config_id:可选结果:成功:status:successvalue:如果未提供config_id则返回列表group_name:分组名com_ids:计算节点location_name:资源池名location_id:资源池idh_id:配置idh_cpu:cpu个数h_weight:cpu权重h_cap:cpu配额h_hard:硬盘大小h_memory:内存大小h_name:配置名h_networknum:网卡数量h_ipnum:ip数量h_bandwith:带宽大小h_desc:配置描述失败:status:failedinfo:info:vmLog说明:获取虚拟机操作日志参数:apikey:client_ip:vm_id:虚拟机id结果:成功status:successvalue:列表id:idoper_time:操作时间client_ip:操作ipdescription:操作内容user_id:用户idvm_id:虚拟机idgetUserResource说明:获取用户的剩余可用资源参数:apikey:client_ip:vm_id: 虚拟机id结果:成功:status:successvalue:res_id:资源idcpu_total:总共cpucpu_free:可用cpumemory_total:总共内存(单位M)memory_free:可用内存(单位M)disk_total:总共硬盘(单位G)disk_free:可用硬盘(单位G)ip_total:总共ipip_free:可用ipnetwork_total:总共网卡network_free:可用网卡失败:status: failedinfo: Error需要验证的接口(仅管理员可调用)userVmList说明:获取资源池里所有的用户虚拟机(管理员可调)参数:apikey:id:资源池idclient_ip:结果:成功:vm_id:虚拟机idvm_name:虚拟机名vm_uuid:虚拟机uuid标识location_id:资源池iduser_id:用户id失败:status: failedinfo: ErrorAdminInfo说明:获取管理员信息参数:apikey:client_ip:id:管理员id结果:成功:status:successvalue:id:管理员idname:管理员用户名password:管理员密码description:描述type_id:类型idgrounp_name:分类名function_list:允许调用的接口notes:分组描述失败:status:failedinfo:AdminId_Null (未提供管理员id)info:AdminId_Invaild (管理员id不存在)addResource说明:添加资源池参数:apikey:client_ip:name:资源池名type:资源池线路类型ip:资源池接口ip(不需要加http:/,但是需要有端口，ip:port)uname:资源池用户名passwd:资源池密码结果:成功:status:successvalue: True失败:status:failedinfo:ErrorupdateResource说明:更新资源池参数:apikey:client_ip:id:资源池idip:资源池ip(格式ip:port)name:资源池名type:资源池线路类似uname:资源池用户名passwd资源池密码结果:成功:status:successvalue: TruedelResource说明:删除资源池 (删除后资源池里的所有虚拟机将无法操作，请先确认资源池里无虚拟机再删除)参数:apikey:client_ip:id:资源池id结果:成功:status:successvalue: True失败:status:failedinfo: Error_IDcomputeGroup说明:获取指定分组或者所有分组信息参数:分组id和资源池id只用提供一个，如果提供分组id则返回单个，如果提供资源池id 则返回所的分组apikey:client_ip:gid:分组idrid:资源池id结果:成功:status:successvalue:如果获取所有的则是列表group_id:分组idlocation_id:资源池idgroup_name:分组名com_ids:计算节点id(逗号分隔所有的id)addGroup说明:添加分组参数: apikey:client_ip:rid:资源池idgroup_name:分组名称cid:计算节点ip列表结果:成功:status:successvalue:True失败:status: failedinfo:Cid_Already_In_Use (计算节点已经被使用)delGroup说明:删除分组参数:apikey:client_ip:gid:分组id结果:成功:status: successvalue: TrueupdateGroup说明:更新分组信息参数:apikey:client_ip:rid:资源池idgid:分组idgroup_name:资源池名cid: 计算节点的id列表结果:成功:status: successvalue: TrueaddIp说明:向资源池添加ip(起始ip和结束ip必须在同一个ip段)参数:apikey:client_ip:rid:资源池idstart_ip:起始ipend_ip:结束ipnetmask:掩码gateway:网关dns:dns结果:成功:status: successvalue: True失败:status: failedinfo: Resource_HaltedupdateIp说明:修改资源池里的ip参数:apikey:client_ip:rid:资源池idipid:ip的idip_address:ip地址结果:成功:status: successvalue: True失败:status: failedinfo: rid_invalid (资源池id不存在)info: Resource_Halted (资源池服务暂不可用)delIp说明:从资源池删除ip参数:apikey:client_ip:rid:资源池idipid:ip的id结果:成功:status: successvalue: True失败:status: failedinfo: rid_invalid (资源池id不存在)info: Resource_Halted (资源池服务暂不可用)listIp说明:列出资源池里的所有IP参数:apikey:client_ip:rid:资源池id结果:成功:status: successvalue: ip列表id:ip idmac:ip对应的mac地址ip:ipnetmask:掩码gateway:网关dns:dnsstate:是否可用vm_uuid:占用的虚拟机失败:status: failedinfo: rid_invalid (资源池id不存在)info: Resource_Halted (资源池服务暂不可用)showIpInfo说明:参数:apikey:client_ip:rid:资源池idipid: ip id结果:成功:status: successvalue: ip列表id:ip idmac:ip对应的mac地址ip:ipnetmask:掩码gateway:网关dns:dnsstate:是否可用vm_uuid:占用的虚拟机失败:status: failedinfo: rid_invalid (资源池id不存在)info: Resource_Halted (资源池服务暂不可用)getHostPerf:说明:获取物理机的性能参数:apikey:client_ip:rid:资源池idcid:计算节点idperiod:周期(单位:分钟)结果:成功:status: successvalue:cpu,memory,vif,disk的rrd数据失败:status: failedinfo: Resource_HaltedsetVhdInfo说明:根据文件名(filename)设置模版虚拟机的详细信息参数:apikey:client_ip:rid:资源池idfilename:文件名name:模版名desc:模版描述enable:可用状态template:基于的何种系统username:系统用户名password:系统密码port:系统远程连接端口结果:成功:status: successvalue: True失败:status: failedinfo: rid_invalid (资源池id不存在)info: Resource_Halted (资源池服务暂不可用)templateVmList说明:获取模版虚拟机列表参数:apikey:client_ip:rid:资源池id结果:成功:status: successvalue:虚拟机列表location_id:资源池idlocation_name:资源池名type:资源池线路类型ip:资源池连接ipuname:资源池用户名passwd:资源池密码vm_id:虚拟机idvm_uuid:虚拟机uuid标识setIsoInfo说明: 根据文件名(filename)设置iso的详细信息参数:apikey:client_ip:rid:资源池idfilename:iso文件名name:iso别名desc:iso描述version:iso版本enable:iso是否可用结果:成功:status: successvalue:True失败:status: failedinfo: Resource_HaltedsetImageConfig说明:设置iso和模版镜像的存放位置信息参数:apikey:client_ip:location_id:资源池idserver:存储机器ippath:存储机器路径type:存储类型(iso/vhd 两者之一)结果:成功:status:successvalue:True失败:status: failedinfo: Resource_HaltedgetImageConfig说明:获取iso和模版镜像的存放位置信息参数:apikey:client_ip:rid:资源池id结果:成功:status:successvalue:iso_server:iso存放路径vhd_server:模版虚拟机存放路径失败:status: failedinfo: Resource_HaltedtemplateVm说明:创建模版虚拟机(如果只提供iso_name则是全新安装,如果只提供img_name则是修改现有虚拟机)参数:apikey:client_ip:rid:资源池idiso_name: iso名称img_name: 现有模版镜像名cid:计算节点idtemplate:基于的系统 (调XenTemplate获取的)memory:内存(单位M)disk:硬盘大小(单位G)结果:成功:status:successvalue:1失败:status:failedinfo:rid_invalidXenTemplate说明:系统类型,虚拟机选择对应的操作系统类型则在性能上有大幅优化参数:apikey:client_ip:rid:资源池idcid:计算节点id结果:成功:status:successvalue:系统类型列表name_label:系统类型uuid:uuid标识失败:status: failedinfo:rid_invalidinfo:Resource_haltedisoList说明:获取资源池里所有的iso参数:apikey:client_ip:rid:资源池idfilename:可选,如果提供此参数则返回单个iso详细信息结果:成功:status:successvalue:如果参数filename未提供则返回列表filename:文件名name:iso别名desc:描述version:版本号(自动生成)enable:可用状态失败:status: failedinfo:rid_invalidinfo:Resource_haltedgetVmList说明:获取资源池里所有虚拟机或者某台计算节点上的所有虚拟机参数:apikey:client_ip:rid:资源池idcid:计算节点id,如果提醒此参数则返回此计算节点上的所有虚拟机结果:成功:status:successvalue:虚拟机列表uuid:虚拟机uuid标识power_state:运行状态name_label:虚拟机名vcpu_max:cpu个数memory_static_min:静态最小内存memory_static_max:静态最大内存memory_dynamic_min:动态最小内存memory_dynamic_max:动态最大内存domid:虚拟机在xen中的iddisksize:虚拟机硬盘大小失败:status: failedinfo:rid_invalidinfo:Resource_haltedaddCompute说明:往资源池里添加计算节点参数:apikey:client_ip:rid:资源池idhostip:计算节点iphostport:计算节点服务监听端口username:计算节点服务器用户名password:计算节点服务器密码结果:成功:status:successvalue:True失败:status: failedinfo:rid_invalidinfo:Resource_halteddeleteCompute说明:从资源池里删除计算节点参数:apikey:client_ip:rid:资源池idcid:计算节点id结果:成功:status:successvalue:True失败:status: failedinfo:rid_invalidinfo:Resource_haltedmodifyCompute说明:修改资源池里的计算节点服务ip或者用户名密码参数:apikey:client_ip:location_id:资源池idcid:计算节点idhostip:计算节点iphostport:计算节点服务监听端口username:计算节点服务器用户名password:计算节点服务器原密码,newpassword: 计算节点服务器新密码,可选结果:成功:status:successvalue:True失败:status: failedinfo:rid_invalidinfo:Resource_haltedlistNetwork说明:列出计算节点上所有的网桥参数:apikey:client_ip:location_id:资源池idcid:计算节点id结果:成功:status:successvalue:网桥列表uuid:网桥uuidbridge:网桥名失败:status: failedinfo:rid_invalidinfo:Resource_haltedagentList说明:获取用户分组列表或者指定的分组参数:apikey:client_ip:agent_id:分组id,可选结果:成功:status:successvalue:如果未提供参数agent_id则返回列表agent_id:分组idtype:分组名失败:status: failedinfo: agentid_invalidaddAgent说明:添加用户分组参数:apikey:client_ip:type:分组名结果:成功:status:successvalue:True失败:status: failedinfo:ErrorupdateAgent说明:修改用户分组参数:apikey:client_ip:agent_id:分组idtype:分组名结果:成功:status:successvalue:True失败:status: failedinfo:ErrordeleteAgent说明:添加用户分组参数:apikey:client_ip:agent_id:分组id结果:成功:status:successvalue:True失败:status: failedinfo:ErroruserInfoList说明:获取所有用户或者指定用户参数:apikey:client_ip:user_id:用户id,可选结果:成功:status:successvalue:如果未提供user_id则返回列表id:idemail:email地址realname:真实姓名jobs:工作company_name:工作单位lastlogintime:上次登录时间registe_time:注册时间user_agent:用户分组idtype:分组名称api_action:可执行操作api_ip:限制访问ip失败:status:failedinfo: agentid_invalidupdateUser说明:更新用户参数: apikey:client_ip:user_id:用户idagent_id:用户分组idpassword:用户密码apiaction允许调用的接口apiip:允许调用接口的ip结果:成功:status:successvalue:True失败:status: failedinfo:userid_invalidinfo:agentid_invalidinfo:ErrordeleteUser说明:删除用户参数: apikey:client_ip:user_id:用户id结果:成功:status:successvalue:True失败:status: failedinfo:ErrorupdateConfig说明:更新配置参数:apikey:client_ip:h_id:配置idh_name:配置名h_desc:配置描述h_cpu:cpu个数cpu_weight:cpu权重cpu_cap:cpu配额h_hard:硬盘大小(单位G)h_memory:内存大小(单位M)h_networknum:网卡个数h_ipnum:ip个数h_bandwidth:带宽控制location_id:所属资源池idgroup_id:所