魔方云系统使用文档>11. 关于三方对接>魔方云对接WHMCS
前言WHMCS插件用于「魔方云系统对接WHMCS」,实现自动化管理,实现whmcs开通,删除云主机开机、关机、重装等管理。支持whmcs版本为「whmcs7.x」一、WHMCS插件下载和安装方法1.1功能支持 1.2 插件下载和安装 ①下载:前往【魔方云系统后台】-【系统设置】-【whmcs设置】-【右上角点击下载whmcs插件】②安装:将下载后的插件【上传至whmcs中】,需将【zjmfcloud文件】上传至【whmcs根目录/module/server/中】二、WHMCS中的设置2.1 服务器对接原理和参数系统通过whmcs预留的server module原生方式对接至whmcs,使用whmcs原生产品设置和配置选项进行产品的价格定义,您可根据教程一步一步完成配置。 2.1.1 添加服务器【前往WHMCS】-【系统设置】-【服务器设置】-【添加新的服务器】*必填字段:NAME(名称):魔方云配置Hostname (主机名):填写访问魔方云系统的域名Ip(IP地址):填写访问魔方云系统的ipType(类型):选择魔方云Username(用户名):登录魔方云系统的账号Password(密码):登录魔方云系统的密码勾选SSL:端口默认为8443,如有变更魔方云访问端口,请填写魔方云端口Hash:必填参数: <zjmfdir>admin</zjmfdir> -- admin #是指魔方云系统设置,安全设置中的后台管理员路径,如果是代理商端对接,填代理商路径 user <user_prefix>自定义的前缀</user_prefix> -- admin #是指魔方云系统设置,安全设置中的后台管理员路径 可选参数: <username> 值</username> #可选参数uid 或者mail ,是指创建魔方云用户时用户名使用whmcs 的UID还是邮箱<account_type>agent</account_type> 增加这行后,插件可用于对接魔方云代理商面板 2.1.2 添加服务器分组【前往WHMCS】-【系统设置】-【服务器设置】-【创建新的分组】 2.1.3 分配服务器至分组 2.1.4 添加产品前往【系统设置】-【产品/服务】-【产品/服务】-【新增产品】产品类型:独服/VPS产品名称:服务器产品型号1模块设置:模块名称-魔方云服务器组:魔方云服务组接口参数设置:请根据以下说明配置参数参数说明注:如果接口设置和可配置项中都配有此参数,优先读取可配置中的表格一配置项名称配置项参数参数说明必选未传递默认值area|数据中心1|CN^香港CN2 1指魔方云系统-区域管理-区域ID注:数据中心和节点id必传一个✔node|节点id1| CN^香港CN2^一区1指魔方云系统-节点管理-节点ID注:数据中心和节点id必传一个不传递系统将自动分配os|操作系统1|windows^windows20081指魔方云系统-镜像管理-操作系统ID✔cpu|CPU2|2核心2指需要为该云主机分配的cpu核心数✔memory|内存1024|1G1024指需要为该云主机分配的内存大小,单位M✔system_disk_size|系统盘20|20G20指需要为该云主机分配的系统盘大小不传递默认50G,Windows系统盘最小30Gstore|系统盘存储1|本地存储1指区域节点-存储管理中的存储ID,选择系统盘开在那个存储下,也可不传递,默认随机network_type|网络类型normal|经典网络vpc|VPC网络normal是指分配的ip地址可直接配置在机器里vpc是指支持浮动ip,机器内不再配置公网ip ✔bw|带宽10|10Mbps10指需要为该云主机分配的上下行带宽不传递默认为0Mbpsin_bw|流入带宽100|100Mbps100指需要为该云主机分配的进带宽如果配置 in_bw 优先使用该参数不传递默认为0Mbpsip_num|IP数量2|2个2指需要为该云主机分配的ip数量✔flow_way|流量方向in|进方向 out|出方向 all|进出汇总方向in指进方向的流量,out指出方向的流量,all指进出方向汇总的流量不传递默认为allflow_limit|流量 1024|1T1024指需要为该云主机分配的流量大小,单位G不传递默认为不限量snap_num|快照数量-1|不开通,0|不限量,5|5个-1指该云主机不能创建快照,0指可以不限量创建快照,5指只能创建5个快照不传递默认2个backup_num|备份数量-1|不开通,0|不限量,5|5个-1指该云主机不能创建备份,0指可以不限量创建备份,5指只能创建5个备份不传递默认2个nat_acl_limit|NAT转发-1|不支持, 0|不限制, 5|5个-1指该云主机不能设置nat转发,0指可以不限量nat转发,5指只能创建5个nat转发不传递默认不支持nat_web_limit|共享建站-1|不支持, 0|不限制, 5|5个-1指该云主机不能nat建站,0指可以不限量nat建站,5指只能创建5个nat建站不传递默认不支持system_disk_io_limit|系统盘性能0,0,0,0|不限制性能,500,500,2000,2000|500持续2000IOPS0,0,0,0指不限制系统盘性能,500,500,2000,2000 读取限制500MB/s,写入限制500MB/s,读取限制2000ops/s,写入限制2000ops/s不传递默认不限制data_disk_io_limit|数据盘性能0,0,0,0|不限制性能,500,500,2000,2000|500持续2000IOPS0,0,0,0指不限制数据盘性能,500,500,2000,2000 读取限制500MB/s,写入限制500MB/s,读取限制2000ops/s,写入限制2000ops/s不传递默认不限制ip_group|IP分组1|电信,2|联通1指魔方云系统-ip管理-ip分组中的IDnode_group|节点分组1|台湾,2|香港1指魔方云系统-区域管理-节点管理-节点分组的IDnode_priority|节点选择优先级(1数量平均,2负载最低,3内存最低,4填满一个)1|数量平均,2|负载最低,3|内存最低,4|填满一个1指在创建实例时,会优先分在节点实例最少的。2指会优化分给节点cpu负载最低的。3指会优先分给节点内存最低的。4指根据节点id从小到大填满一个的方式创建实例,当节点资源达到限制后,就在其他节点开通实例。不传递默认数量平均IP_MACBond|嵌套虚拟化0|关闭绑定,1|开启绑定0指关闭IP-MAC绑定,1指开启IP-MAC绑定不传递默认开启绑定cpu_limit|CPU限制50|50%50指开通实例设置CPU限制为50%不传递默认以魔方云系统设置为准traffic_bill_type|流量计费周期month|自然月, last_30days|订购日至下月month是指每月1日流量进行清零,last_30days|是指产品开通日至下月进行清零不传递默认每月1日清零type|云节点类型host|KVM加强版,lightHost|KVM轻量版,hyperv|Hyper-V ,adsl|拨号云host是指KVM加强版节点类型,lightHost是指KVM轻量版节点类型,hyperv是指Hyper-V节点类型,adsl是指拨号云节点类型不传递默认KVM加强版advanced_bw|智能带宽1|降至30%1指在魔方云系统-监控-智能规则-智能带宽的IDadvanced_cpu|智能CPU1|降至50%1指在魔方云系统-监控-智能规则-智能CPU的IDport|端口auto|随机端口auto指随机端口不传递默认不支持data_disk_size|数据盘20,1|20G20指需要为该云主机分配的数据盘大小,单位G;1指区域节点-存储管理中的存储ID,选择数据盘开在那个存储下,也可不传递,默认随机。不传递默认无数据盘data1_disk_size|数据盘20,1|20G多块数据盘分配的时候增加使用该参数data2_disk_size|数据盘20,1|20Gdata3_disk_size|数据盘20,1|20Gdata4_disk_size|数据盘20,1|20Gipv6_num|ipv6数量2|2个2指ipv6地址数量为2个gpu_num|GPU数量1|1个GPU1指GPU显卡的个数不传递默认不支持simulate_physical_machine|模拟物理机运行1|开启0|关闭1指创建云主机时开启模拟物理机运行0指创建云主机时关闭模拟物理机运行不传递默认关闭模拟物理机运行ip_num_[1-6]2|2个2指ip数量,1指ip管理-ip分组中的IDIP数量都必须对应一个分组才行,可配置相同分组:例如 ip_num_1对应ip_group_1,以此类推,如果没有对应上,则ip_num不生效;例如:配置了ip_num_6,没有配置ip_group_6,则ip_num_6下的选项均不生效魔方云3.8.6+支持ip_group_[1-6]1|ip分组12.1.5 重装系统时能够选择格式化数据盘功能【仅对接的魔方云是专业版可用】在服务器-访问哈希中加上这一段<format_data_disk>true</format_data_disk>,保存更改2.2 可配置选项原理和参数我们使用whmcs可配置选项功能进行配置选项传递,包含以下产品,格式为: 参数 | 显示名称前往【系统设置】-【产品/服务】-【可配置选项】-【Create a New Group】Group Name:配置组名称Description:描述自定义Assigned Products:指定产品Add New Configurable Option:点击添加新的可配置选项注:添加配置参数可参考上面表格一,方法都是一致,本教程就添加一个为范例。四、WHMCS前后台管理4.1 产品对接魔方云实现开机关机重装后台管理完成以上配置后,我们即可实现对接管理,为客户添加产品后进行测试即可。4.1.1产品开通(自动和手动)(1)随机分配开通:正常流程下单,管理员手动通过模块命令执行“开通”,或者设置下单自动开通该开通方式,在魔方云里按照要求,随机分配配置信息,新开通云主机(2)指定主机开通:在whmcs端正常下单服务器,然后在管理员后台,产品/服务中,找到对应的订单,通过输入hostid(对应云主控实例列表中的id)来对应开通魔方云中已存在的机器该开通方式主要用于已经在使用的主机,指定分配给用户,这种方式的开通不会对服务器进行重装操作五、问题说明5.1 用户名密码错误检查WHMCS的服务器设置的用户名和密码是否是魔方云登录的用户名及密码5.2 连接端口错误检查SSL端口是否填写正确5.3 魔方云无法连接检查WHMCS服务器设置中的主机名及IP是否是魔方云的访问ip