一：api接口验证方式
api接口验证地址：http://主控域名/api/v3
api接口响应方式：http post get
api接口ip白名单：支持(建议后台设定有效的api白名单ip)
api验证公共参数：
| 参数 |
类型 |
说明 |
是否必须 |
| api_sign |
string |
md5(api秘钥+api_random+api_timestamp)，小写md5 |
是 |
| api_random |
string |
随机数（保证不会重复） |
是 |
| api_timestamp |
int |
时间戳（10位长度） |
是 |
| api_language |
string |
如果等于chinese，那么将错误信息返回中文简体（utf-8编码），为空返回英文错误提示 |
否 |
| api_type |
string |
vhost |
是 |
| action |
string |
填写下面接口名称 |
是 |
二：api接口响应模式
| 响应类型 |
响应返回值 |
说明 |
| 成功 |
0 或 0|相关数据 |
操作成功后的返回值 |
| 失败 |
-1|错误内容 |
只要判断前缀是否-1| 就代表错误 截取|后面错误内容返回 |
| 查询数据 |
json数组 |
根据查询列表接口返回json数组,如查询失败,签名失效等,也会返回-1,如果查询为空返回空 |
三：api接口操作
(测试通讯） 接口名称：test
成功返回：0
(创建用户) 接口类型：user_add
| 参数名 |
参数说明 |
必须 |
| userid |
自定义用户编号，可以是第三方财务的用户id传入，保证唯一性 |
是 |
| username |
用户名 |
是 |
| password |
密码 >=6位 |
是 |
| name |
姓名/名称等 |
否 |
| email |
邮箱地址 |
是 |
| phone |
手机号码 |
否 |
| vcount |
服务数量 默认0 |
否 |
| utype |
默认0（0=普通用户，10=管理员级别，其他自定义分组id） |
否 |
| status |
用户状态（0=正常用户 1=禁止用户） |
是 |
| remark |
用户备注信息 |
否 |
| mail_verified |
默认0，等于1为该邮箱地址已验证 |
否 |
| mobile_verified |
默认0，等于1为该手机号码已验证 |
否 |
| reg_ip |
注册ip地址 |
否 |
| login_ip |
登录ip地址 |
否 |
成功返回0|188 注意这个188是数据库自增的编号（并非userid编号）
(修改用户) 接口类型：user_update
| 参数名 |
参数说明 |
必须 |
| id |
数据库查询中的自增id（非userid） |
是 |
| userid |
修改用户编号，类似过户，一般为空不修改 |
否 |
| password1 |
为空不修改，反之大于6位 |
否 |
| password2 |
确认密码，为空不修改，反之大于6位 |
否 |
| name |
姓名/名称 |
否 |
| email |
邮箱地址 |
否 |
| phone |
手机号码 |
否 |
| username |
用户名 |
否 |
| vcount |
服务数量 |
否 |
| utype |
0=普通用户，10=管理员级别 |
否 |
| status |
0=正常，1=禁用账号 |
否 |
| mail_verified |
等于1已验证邮箱 |
否 |
| mobile_verified |
等于1已验证手机号 |
否 |
| cvdate |
重装限制日期如20190501 或则低于当前时间或则0或则留空即可 |
否 |
| rvcount |
按用户级别 已重装的次数 |
否 |
| reg_ip |
注册ip地址 |
否 |
| login_ip |
登录ip地址 |
否 |
成功返回0
(删除用户) 接口类型：user_ｄelete
| 参数名 |
说明 |
必须 |
| userid |
用户编号，（您创建时自定义的非自增id） |
是 |
成功返回0
(查询用户) 接口类型：user_info
| 参数名 |
说明 |
必须 |
| id |
数据库中自增生成的编号 |
否 |
| userid |
自定义的用户编号 |
否 |
| username |
用户名 |
否 |
| name |
按名称 |
否 |
| email |
邮箱地址 |
否 |
| phone |
手机号码 |
否 |
| utype |
用户组id（0=普通用户，10=管理员） |
否 |
| login_ip |
按登录ip查询（已包含注册ip全部索引查询） |
否 |
| remark |
按备注信息模糊查询 |
否 |
成功返回json数组，不存在返回为空
(vhost登录独立面板) 接口类型：http://主控域名/process?c=login 请自己组合一个form表单拼接进行提交该接口post类型
| 参数名 |
说明 |
必须 |
|
logintype
|
登录类型：vhost |
是 |
| username |
ftp账号 |
是 |
| password |
ftp密码 |
是 |
成功自动跳转独立面板，所以get post都可以使用该接口
(vhost创建) 接口类型：vhost_create
| 参数名 |
说明 |
必须 |
| userid |
vm开通到那个用户编号下 |
是 |
| areaid |
按区域id开通，自动轮训区域下全部节点，如要指定节点开通请为空 |
是/否 |
| nodeid |
按指定节点id开通 |
是/否 |
|
aspscript
|
1=启用asp，0=不启用asp脚本 （默认0） |
否 |
| phpscript |
1=启用php，0=不启用php脚本 （默认0） |
否 |
|
aspxscript
|
1=启用asp.net，0=不启用asp.net脚本(简称.aspx脚本) （默认0） |
否 |
| enable_mysql |
1=启用mysql，0=不创建mysql数据库 （默认0） |
否 |
| mysqlspace |
开通mysql数据库的空间容量，需以上enable_mysql=1才有效 |
否 |
|
mysqlbackupnum
|
mysql数据库允许备份的数量，需以上enable_mysql=1才有效 |
否 |
| enable_mssql |
1=启用sql server，0=不创建sql server数据库 （默认0） |
否 |
|
mssqlspace
|
开通sql server数据库的空间容量，需以上enable_mssql=1才有效 |
否 |
| mssqlbackupnum |
sql server数据库允许备份的数量，需以上enable_mssql=1才有效 |
否 |
| domains |
绑定的域名多个以英文,逗号分割，如没有可留空，默认有赠送域名 |
否 |
| ftpname |
ftp虚拟主机名称，最少5位，且必须是英文开通或英文数字组合，不可包含特殊字符 |
否 |
|
ftppassword
|
ftp密码 英文数字组合 |
否 |
| cpulimit |
对站点的cpu限制百分比（仅对独立池有效）100为不限制 |
是 |
| ram |
专用内存 单位mb 不限制设置0 |
否 |
| diskspace |
磁盘可用容量，单位mb |
是 |
| bindingdomain |
允许绑定的域名数量 |
是 |
|
maxconnections
|
iis连接数量，0=不限制，否则推荐50~300 |
是 |
|
bwlimit
|
是否限制流量，0=不限制，否则单位gb 默认0 |
否 |
|
maxbandwidth
|
站点可用宽带，最小1，单位mb |
是 |
| apppoolnum |
多少个用户站点共享池，1=每个站点一个独立池，否则输入如20=20个用户站点共享一个池 |
是 |
| hostip |
主机ip，留空为共享ip，输入1为自动随机选取一个独立ip (默认空) |
否 |
| phpversion |
php版本可选(5.2,5.3,5.4,5.5,5.6,7.0,7.1,7.2,7.3,7.4,8.1),前提已安装php一键安装包 |
否 |
| netversion |
net版本(.aspx站点用途)，可选范围(2.0，4.0)，注意：2.0包含3.5了 |
是 |
| netmode |
池模式，0=经典(推荐)，1=集成，（针对独立池用户），默认0 |
否 |
| defaultdoc |
默认主页如：index.asp,index.php 多个以英文逗号分割，留空系统自动处理 |
否 |
| remark |
主机创建时的备注，可留空 |
否 |
| returnjson |
如果等于1，成功返回 0|主机vhost表的json信息 |
否 |
成功返回：0|123 后面的123代表主控返回的虚拟主机id编号
如果returnjson=1，那么成功返回 0|json信息 如：
提示：json中字段 mysql_xxx和mssql_xxx 代表附带的数据库信息，如果未开通数据库这些字段是没有的
0|{"freedomain":"mssql002.123.com","ftpname":"mssql002","ftppassword":"a1231","ftpport":"21","hostip":"192.168.3.18","id":"582","mssql_sqlid":"38","mssql_sqlip":"192.168.3.18","mssql_sqlname":"a1675270013","mssql_sqlpass":"we5auyy8whu0","mssql_sqluser":"a1675270013","nodeid":"3","userid":"8080"}
(vhost更新) 接口类型：vhost_update
| 参数名 |
说明 |
必须 |
| id |
编辑修改的主机id |
是 |
| update_host |
默认0只更改数据库信息，为1时实时更改iis站点信息以及数据库信息 |
否 |
| nodeid |
节点id（无特殊情况无需修改） |
否 |
| userid |
修改用户编号（类似过户） |
否 |
| cpulimit |
修改站点池cpu百分比，100=不限制，（仅对独立池有效） |
否 |
| ram |
专用内存 单位mb，不限制设置0 |
否 |
| diskspace |
磁盘容量，单位mb |
否 |
| bindingdomain |
绑定域名数量，留空不修改 |
否 |
| maxconnections |
站点iis数量 |
否 |
| maxbandwidth |
站点宽带 （单位mb） |
否 |
| bwlimit |
0=不限流量，否则限制流量，单位g |
否 |
| bwusage |
已用流量，单位gb，支持浮点数，一般这个无需改 |
否 |
| bwdate |
下次流量重置日期，一般开通按月周期算，一般无需改，改动请传时间戳10位数 |
否 |
| phpversion |
php版本可选(5.2,5.3,5.4,5.5,5.6,7.0,7.1,7.2,7.3,7.4,8.1),前提已安装php一键安装包 |
否 |
| netversion |
net版本(.aspx站点用途)，可选范围(2.0，4.0)，注意：2.0包含3.5了 |
否 |
| netmode |
池模式，0=经典（推荐），1=集成，（针对独立池用户） |
否 |
| hostip |
主机ip更改，留空不更改，否则请到ip池列表选取ip传入更改 |
否 |
| status |
主机状态（1=锁定，2=正常，-1=中止，-2=超流量运行，-3=超流量停止） |
否 |
| remark |
备注信息更改，留空不修改 |
否 |
成功返回0
(vhost删除) 接口类型：vhost_ｄelete
| 参数名 |
说明 |
必须 |
|
hostid
|
主机编号 |
是 |
| forceｄelete |
默认0，为1强制删除主机 |
否 |
| returnmsg |
默认空，为1时删除后成功返回 0|json信息 |
否 |
成功返回0 如果returnmsg=1 那么成功返回 0|json信息
(查询主机信息以及状态) 接口类型：state
成功返回
running|{"apppoolname":"1_rstack_13","apppoolnum":"1","aspscript":"1","aspxscript":"1","bwdate":"1678434670","bwlimit":"500","bwusage":"0","defaultdoc":"","freedomain":"host1676015469.123.com","ftpname":"host1676015469","ftpport":"21","hostip":"192.168.3.18","netmode":"0","netversion":"2.0","phpscript":"1","phpversion":"7.4","status":"2","userid":"8080"}
（按|分割） 在|前者是状态 ，后者是一些任务进度的类型 名称等字面意思
状态有：
locked，overdue，overbw，running，off，unknown
（锁定，过期中止，超流量停机，运行中，关闭中，未知站点）
(查询主机信息以及状态) 接口类型：state_json
成功返回json数组 【实时状态state=running,stop,unknown】,【静态主机状态status=对应主控的主机状态】
{"apppoolname":"1_rstack_8","apppoolnum":"1","aspscript":"1","aspxscript":"1","bwdate":"1677073377","bwlimit":"0","bwusage":"0","defaultdoc":"index.asp,index.php,default.htm,default.asp,index.htm,index.html,iisstart.htm,default.aspx","freedomain":"vhost001.123.com","ftpname":"vhost001","ftpport":"21","hostid":"552","hostip":"192.168.3.18","netmode":"0","netversion":"2.0","phpscript":"1","phpversion":"7.4","state":"running","status":"2","userid":"8080"}
(vhost主机电源操作) 接口类型：start，stop
成功返回0
(主机状态获取) 接口类型：set_ftppassword
| 参数名 |
说明 |
必须 |
| hostid |
主机编号 |
是 |
|
new_ftppassword
|
新的ftp密码，英文数字，长度>=6 |
是 |
成功返回：0
(主机添加域名） 接口类型：add_domain
| 参数名 |
说明 |
必须 |
| hostid |
主机编号 |
是 |
| scheme |
http,https 留空默认http |
否 |
| domainname |
域名如：www.baidu.com |
是 |
| domainport |
域名对应端口一般，http=80，https=443，留空默认=80 |
否 |
成功返回0
(主机删除域名） 接口类型：del_domain
| 参数名 |
说明 |
必须 |
| hostid |
主机编号 |
是 |
|
domainid
|
要删除的域名id |
是 |
成功返回0
