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

《云主机管理系统API对接文档支持慧琳whmcsperimer.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、/json/返回json格式对象不需要验证的接口userLogin说明:前台用户登录,由于有访问限制,请务必提交客户端ip参数:agent_ip:客户端ipuser_name:用户名password:密码结果:成功:status:successvalue:id:用户idapikey:操作密钥失败:status:failedinfo:Auth_failedregUser说明:前台用户注册参数:realname:真实姓名email:email地址pwd:密码company_name:公司名jobs:

2、职位结果:成功:status:successvalue:id:用户idapikey:操作密钥失败:status:failedinfo:Email_ExistsauthAdmin说明:后台管理员登录参数:admin_name:管理员名password:管理员密码结果:成功:status:successvalue:admin_id:管理员idapikey:操作密钥priv_list:权限列表失败:status:failedinfo:Auth_failedresetPass说明:重置密码，管理员可调参

3、数:email:emailoldpwd:原密码newpwd:新密码结果:成功:status:successvalue:True失败:status:failedinfo:ErrordoVNCConnect说明:请求一个webvnc连接参数:vm_id:虚拟机id结果:成功:status:successvalue:端口失败:status:failedinfo:vmid_invalidinfo:Resource_Halted需要验证的接口(管理员和用户都可调用)凡是此接口参数都必须带上apikey，如

4、果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说明:获取指定资源池或者所有资源池列表参数:api

5、key:client_ip:location_id:资源池id(可选)location_name:资源池名(可选)结果:成功:status:successvalue:列表location_id:资源池idlocation_name:资源池名type:线路类型(仅管理员可见)uname:资源池用户名(仅管理员可见)passwd:资源池密码(仅管理员可见)ip:资源池接口(仅管理员可见)失败:status:failedinfo:Error_IdcreateVm说明:创建虚拟机参数:apikey:vm

6、_name:虚拟机名config_id:方案iduser_id:虚拟机所属用户idclient_ip:客户端ip(操作记录用)image_name:模版名rid:资源池id返回:成功:status:successvalue:1失败：status:failedinfo:Resouce_HaltedimageList说明:获取指定资源池上的模版镜像列表或者指定模版镜像参数:apikey:rid:资源池idfilename:模版镜像名(可选，如果包括则返回单个值)结果:成功:status:succes

7、svalue:[如果参数包括filename则是列表，反之是字典]name:模版名desc:模版描述version:(系统自动生成的一个版本号)enable:可用状态template:基于何种操作系统username:系统用户名password:系统密码port:系统远程连接端口失败:status:failedinfo:rid_invalid（资源池不存在）info:Resource_halted（资源池暂不可用）getVmInfo说明:获取虚拟机信息参数:apikey:client_ip:vm

8、_id:虚拟机idis_template:是否为模版虚拟机结果:成功:status:succesvalue:state:虚拟机状态[RUNNING(运行中),HALTED(关机),BUILDING(创建中),EXCEPT(异常,造成此状态的原因可能是网络中断或者节点服务中断)]lblvmmemory:虚拟机内存(单位M)lblvmcpu:虚拟机cpu个数address:虚拟机ipdisk:虚拟机硬盘大小(单位G)vnc_password:虚拟机vnc密码lock:虚拟机锁定状态computer_