概述 v1.0.0

开发者需要按照如下步骤完成：
1、API通过HTTP GET POST 方式进行调用（大部分接口GET和POST通用。
2、API调用之前需要登陆主控后台 – 常规管理 – 系统配置 – 安全配置，设置API通信密钥(access_token)
3、API通过POST请求参数均为数组方式
4、所有接口都需要签名验证

API请求限制

所有API签名失效时间是10s

接口返回数据类型

所有接口返回数据格式为：JSON

其他说明

接口请求参数及地址请以版本为准

数据库类

可以创建宝塔数据库，也可以添加自定义数据库到主机中

该接口暂停使用

POST 创建数据库

• 接口状态：需修改
• 接口URL：POST {{api_url}}/sql_build
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

{"code": 1,"msg": "创建成功","time": "1598758968","data": {"vhost_id": 24, //主机ID"username": "test111111", //用户名"database": "test111111", //数据库名"password": "test123456", //密码"console": "http://xxxxx.com", //控制台地址"id": "27" //数据库ID}}

POST 数据库详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/sql_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

失败（201）

{"code": 0,"msg": "错误的请求","time": "1598759010","data": null}

成功（200）

{"code": 1,"msg": "请求成功","time": "1602573937","data": {"id": 66, //数据库ID"vhost_id": 77, //主机ID"username": "x1mbnw", //用户名"database": "x1mbnw", //数据库名"password": "AocjfgnJvdVe", //密码"console": "http://192.168.191.129:888/phpmyadmin_2b42747a02485e2d", //控制台地址"type": "bt",  "createtime": 1601882600,"updatetime": 1601882600,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=禁用"status_text": "正常"}}

POST 数据库修改密码

• 接口状态：已完成
• 接口URL：POST {{api_url}}/sql_pass
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

{"code": 1,"msg": "修改成功","time": "1598762105","data": {"id": 27, //数据库ID"vhost_id": 24, //主机ID"username": "test111111", //用户名"database": "test111111", //数据库名"password": "123456", //新密码"console": "http://xxxxx.com", //控制台地址"type": "bt", //类型:bt=宝塔,custom=自定义"createtime": 1598758968,"updatetime": 1598762106,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=禁用"status_text": "正常"}}

网站分类

POST 编辑网站分类

• 接口状态：已完成
• 接口URL：POST {{api_url}}/sort_edit
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "修改成功","time": "1602580684","data": null}

失败（201）

复制

{"code": 0,"msg": "指定分类名称已存在!","time": "1602580583","data": null}

POST 创建网站分类

• 接口状态：已完成
• 接口URL：POST {{api_url}}/sort_create
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "创建成功","time": "1602580576","data": null}

失败（201）

复制

{"code": 0,"msg": "指定分类名称已存在!","time": "1602580583","data": null}

POST 删除网站分类

• 接口状态：已完成
• 接口URL：POST {{api_url}}/sort_delete
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "删除成功","time": "1602580775","data": null}

失败（201）

复制

{"code": 0,"msg": "指定分类不存在!","time": "1602580782","data": null}

POST 获取网站分类列表

• 接口状态：已完成
• 接口URL：GET {{api_url}}/sort_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1602580881","data": [{"id": 0, //分类ID"name": "默认分类" //分类名称}]}

用户

POST 创建用户

• 接口状态：已完成
• 接口URL：POST {{api_url}}/user_create
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "创建成功","time": "1601876490","data": {"username": "H87eFRja", //账号"password": "MdSV8Tq2", //密码"group_id": 1, //用户组ID"nickname": "H87eFRja", //昵称"createtime": 1601876490,"updatetime": 1601876490,"id": "3", //用户ID"host_count": 0 //主机总数}}

失败（201）

复制

{"code": 0,"msg": "用户名已存在，请勿重复创建","time": "1601876847","data": null}

POST用户编辑

• 接口状态：已完成
• 接口URL：POST {{api_url}}/user_edit
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "修改成功","time": "1601878544","data": null}

失败（201）

复制

{"code": 0,"msg": "用户不存在","time": "1601878698","data": null}

POST用户登录

版本<1.4.0将存在严重安全问题，1.4.0开始使用html模拟登录，无需签名，传递账号密码登录
下面是示例代码

<form action="{{api_url}}/host_login" method="post">
<input type="hidden" name="id" value="120" />
<input type="hidden" name="account" value="ypackz1" />
<input type="hidden" name="password" value="O9shMvuWFiJ5" />
<input type="submit"  id="login" value="登录控制面板" />
</form>
<script>
    setTimeout(function(){
        var login = document.getElementById('login');
        login.click();
    },200);
</script>

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_login
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

请求成功后将直接跳转到控制面板，如传递主机ID将跳转指定主机控制面板页面，如未传递主机ID将跳转到站点选择页面
ps：该接口也适用于主机登录

失败（201）

复制

{
	"code": 0,
	"msg": "没有找到有效主机",
	"time": "1611805958",
	"data": "/"
}

POST用户删除

bthost版本大于等于1.0.3

仅删除用户，用户所属站点等信息不会删除

• 接口状态：已完成
• 接口URL：POST {{api_url}}/user_del
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "删除成功","time": "1601876875","data": null}

失败（201）

复制

{"code": 0,"msg": "用户不存在","time": "1601876887","data": null}

POST用户列表

• 接口状态：已完成
• 接口URL：POST {{api_url}}/user_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1600005649","data": [{"id": 1,"group_id": 1, //用户组ID"username": "admin", //用户名"nickname": "Admin", //昵称"password": "123456", //密码"avatar": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgaGVpZ2h0PSIxMDAiIHdpZHRoPSIxMDAiPjxyZWN0IGZpbGw9InJnYigxNjAsMjI5LDIwMykiIHg9IjAiIHk9IjAiIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48L3JlY3Q+PHRleHQgeD0iNTAiIHk9IjUwIiBmb250LXNpemU9IjUwIiB0ZXh0LWNvcHk9ImZhc3QiIGZpbGw9IiNmZmZmZmYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIHRleHQtcmlnaHRzPSJhZG1pbiIgYWxpZ25tZW50LWJhc2VsaW5lPSJjZW50cmFsIj5BPC90ZXh0Pjwvc3ZnPg==", //头像"prevtime": 1600003605,"logintime": 1600003972,"loginfailure": 0,"createtime": 1597552377,"updatetime": 1600003972,"deletetime": null,"notice": "admin1", //备注"status": "normal", //状态:normal=正常,hidden=停用,locked=锁定"host_count": 18 //持有主机总数}]}

POST用户信息

• 接口状态：已完成
• 接口URL：POST {{api_url}}/user_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598508332","data": {"id": 1,"group_id": 1, //用户组ID"username": "admin", //用户名"nickname": "Admin", //昵称"password": "admin000", //密码"avatar": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgaGVpZ2h0PSIxMDAiIHdpZHRoPSIxMDAiPjxyZWN0IGZpbGw9InJnYigxNjAsMjI5LDIwMykiIHg9IjAiIHk9IjAiIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48L3JlY3Q+PHRleHQgeD0iNTAiIHk9IjUwIiBmb250LXNpemU9IjUwIiB0ZXh0LWNvcHk9ImZhc3QiIGZpbGw9IiNmZmZmZmYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIHRleHQtcmlnaHRzPSJhZG1pbiIgYWxpZ25tZW50LWJhc2VsaW5lPSJjZW50cmFsIj5BPC90ZXh0Pjwvc3ZnPg==", //头像"prevtime": 1598407278,"logintime": 1598407808,"loginfailure": 0,"createtime": 0,"updatetime": 1598408547,"deletetime": null,"notice": "", //备注"status": "normal" //状态:normal=正常,hidden=停用,locked=锁定}}

FTP类

POST ftp密码修改

• 接口状态：已完成
• 接口URL：POST {{api_url}}/ftp_pass
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "修改成功","time": "1598763798","data": {"id": 25, //FTPID"vhost_id": 33, //主机ID"username": "kgtge1", //用户名"password": "123456", //新密码"createtime": 1598511305,"updatetime": 1598763799,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=禁用"status_text": "正常"}}

POST ftp详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/ftp_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598763849","data": {"id": 25, //FTPID"vhost_id": 33, //主机ID"username": "kgtge1", //用户名"password": "123456", //新密码"createtime": 1598511305,"updatetime": 1598763799,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=禁用"status_text": "正常"}}

POST ftp状态修改

• 接口状态：已完成
• 接口URL：POST {{api_url}}/ftp_status
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "修改成功","time": "1603893124","data": {"id": 82,"vhost_id": 94,"username": "57d0td","password": "itEhaUTYHslP","createtime": 1603892246,"updatetime": 1603893124,"deletetime": null,"status": "normal","status_text": "正常"}}

接口域名说明

所有接口发起调用域名，应当为被控域名
比如我安装的被控程序域名为http://www.btye.net
那么发起API调用的地址应当为：http://www.btye.net/api/vhost（主地址）
下面文档将环境变量{{api_url}}作为示例地址，请求时请自行替换

全局接口返回状态效验及说明

使用统一标准返回json，格式如下
成功请求返回格式：

{
    "code": 1,
    "msg": "请求成功",
    "time": "1598499280",
    "data": []
}

失败请求返回格式：

{
    "code": 0,
    "msg": "错误的请求",
    "time": "1598500617",
    "data": null
}

全局接口请求状态效验依据接口返回JSON下的code==1时，代表接口调用成功。

主机管理类

POST域名绑定

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_domain
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "添加成功","time": "1602834510","data": {"vhost_id": 82,"domain": "husdghuagfhja21sb.com","dir": "/","status": 1,"createtime": 1602834510,"updatetime": 1602834510,"id": "47","audit_text": "","status_text": ""}}

失败（201）

复制

{"code": 0,"msg": "指定域名已绑定过!","time": "1602834519","data": null}

POST主机创建

如传递plans_id则使用系统中的资源套餐配置

如不传递plans_id则可以传递自己的建站参数pakc[]

传递时间的格式请严格按照Y-m-d格式传递，如2020-09-02，如单数月、日，需要补充0，请勿传递2020-9-2格式日期

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_build
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "创建成功","time": "1600000039","data": {"site": {"user_id": "1", //用户ID"sort_id": "1", //分类ID"bt_id": 183, //宝塔ID"bt_name": "emgrpa.yum7.cn", //站点名"site_max": "0", //站点大小(M)"sql_max": "0", //数据库大小(M)"flow_max": "0", //流量(月)大小(M)"is_audit": "0", //域名审核:0=不审核,1=审核"is_vsftpd": "0", //vsftpd:0=否,1=是"domain_max": "5", //域名绑定数"web_back_num": "5", //网站备份数"sql_back_num": "5", //数据库备份数"ip_address": [], //IP地址"endtime": 1598630400, //站点到期时间"createtime": 1600000039,"updatetime": 1600000039,"id": "69" //主机ID}, //站点信息"domain": {"domain": "emgrpa.yum7.cn", //域名"vhost_id": "69", //主机ID"domain_id": 3,"dnspod_record": "", //dnspod解析值"dnspod_record_id": "", //dnspod记录值ID"dnspod_domain_id": "", //dnspod域名ID"dir": "/", //域名绑定目录"createtime": 1600000039,"updatetime": 1600000039,"id": "26","audit_text": "","status_text": ""}, //域名信息"sql": {"vhost_id": "69", //站点ID"database": "emgrpa","username": "emgrpa", //用户名"password": "QKk1E73oOU68", //密码"createtime": 1600000039,"updatetime": 1600000039,"id": "58", //sql_id"status_text": ""}, //数据库信息"ftp": {"vhost_id": "69", //站点ID"username": "emgrpa", //用户名"password": "QKk1E73oOU68", //密码"createtime": 1600000039,"updatetime": 1600000039,"id": "57", //ftp_id"status_text": ""} //FTP信息}}

失败（201）

复制

{"code": 0,"msg": "时间格式错误，请严格按照Y-m-d格式传递","time": "1598512525","data": null}

POST 主机登录

版本<1.4.0将存在严重安全问题，1.4.0开始使用html模拟登录，无需签名，传递账号密码登录
下面是示例代码

<form action="{{api_url}}/host_login" method="post">
<input type="hidden" name="id" value="120" />
<input type="hidden" name="account" value="ypackz1" />
<input type="hidden" name="password" value="O9shMvuWFiJ5" />
<input type="submit"  id="login" value="登录控制面板" />
</form>
<script>
    setTimeout(function(){
        var login = document.getElementById('login');
        login.click();
    },200);
</script>

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_login
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

请求成功后将直接跳转到控制面板，如传递主机ID将跳转指定主机控制面板页面，如未传递主机ID将跳转到站点选择页面
ps：该接口也适用于用户登录

失败（201）

复制

{
	"code": 0,
	"msg": "没有找到有效主机",
	"time": "1611805958",
	"data": "/"
}

POST 主机升级

支持一键升级、降级到指定套餐

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_update
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "更新成功","time": "1607739731","data": {"id": 82,"user_id": 1,"sort_id": 8,"bt_id": 211,"bt_name": "8nvh7l.yum7.cn","site_size": 0,"site_max": 200,"flow_size": 0,"flow_max": 1024,"sql_size": 0,"sql_max": 200,"ip_address": [],"domain_max": 5,"is_audit": 0,"check_time": 1607738587,"web_back_num": 5,"sql_back_num": 5,"perserver": 0,"limit_rate": 0,"is_vsftpd": "0","sub_bind": "1","notice": null,"createtime": 1602758558,"updatetime": 1607738587,"deletetime": null,"endtime": 1609344000,"status": "normal"}}

失败（201）

复制

{"code": 0,"msg": "错误的请求","time": "1598512106","data": null}

POST 主机编辑

修改主机信息，必须修改其中一个数据，也可以全部修改

传递时间的格式请严格按照Y-m-d格式传递，如2020-09-02，如单数月、日，需要补充0，请勿传递2020-9-2格式日期

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_edit
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "更新成功","time": "1598576131","data": {"id": 24,"user_id": 1, //用户ID"sort_id": 5, //分类ID"bt_id": 118, //宝塔ID"bt_name": "q5ki2m.bty6.com", //站点名"site_size": 57, //网站使用量(M)"site_max": 200, //网站大小(M)"flow_size": 0, //流量(月)使用量(M)"flow_max": 1024, //流量(月)大小(M)"sql_size": 0, //数据库使用量(M)"sql_max": 200, //数据库大小(M)"ip_address": "192.168.0.159", //IP地址"ip_addresss": null, //附属IP"domain_max": 5, //域名绑定数"default_analysis": "", //默认解析地址"is_audit": 1, //域名绑定实名认证"check_time": null, //最后检查时间"analysis_type": "", //解析方式及说明"web_back_num": 5, //网站可备份数"sql_back_num": 5, //数据库可备份数"is_vsftpd": "0", //vsftpd:0=否,1=是"notice": "这是备注", //网站备注"createtime": 1597624305,"updatetime": 1598576131,"deletetime": null,"endtime": 1601481600, //到期时间"status": "normal" //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常}}

POST 主机详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1602573821","data": {"id": 67, //IP地址ID"user_id": 1, //用户ID"sort_id": 0, //分类ID"bt_id": 9, //宝塔ID"bt_name": "xkzs501.xxx.com", //站点名"site_size": 43, //站点使用量(M)"site_max": 200, //站点大小(M)"flow_size": 0, //流量(月)使用量(M)"flow_max": 1024, //流量(月)大小(M)"sql_size": 0, //数据库使用量(M)"sql_max": 200, //数据库大小"ip_address": [], //IP地址"domain_max": 5, //可绑定域名数"is_audit": 0, //域名绑定审核"check_time": 1602573543, //最后检查时间"web_back_num": 5, //网站备份数"sql_back_num": 5, //数据库备份数"is_vsftpd": "0", //vsftpd:0=否,1=是"notice": "admin Site:100 Sql:100 Flow:100", //站点备注"createtime": 1599984234,"updatetime": 1602573543,"deletetime": null,"endtime": 1609344000, //站点到期时间"status": "stop", //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常"default_analysis": "xkzs501.xxx.com", //默认解析地址"sql": [], //数据库"ftp": {"id": 55,"vhost_id": 67,"username": "xkzs501","password": "123456","createtime": 1599984234,"updatetime": 1599996774,"deletetime": null,"status": "normal","status_text": "正常"}, //FTP"domain": [{"id": 20,"domain": "dasjdikasjkdajs.com","vhost_id": 67,"domain_id": null,  "dnspod_record": null,"dnspod_record_id": null,"dnspod_domain_id": null,"dir": "/","createtime": 1599996970,"updatetime": 1599996970,"deletetime": null,"status": "1","audit_text": "","status_text": ""}] //域名}}

失败（201）

复制

{"code": 0,"msg": "错误的请求","time": "1598512106","data": null}

POST 主机状态

如果返回状态码不对应，请使用主机同步接口进行同步主机状态！

normal:1,stop:0,locked:0 属于状态同步

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_status
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598511986","data": {"loca": "normal", //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常"server": "1" //云端状态:0=停用,1=正常}}

POST 主机列表

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598508832","data": [{"id": 23, //IP地址ID"user_id": 1, //用户ID"sort_id": 5, //分类ID"bt_id": 117, //宝塔ID"bt_name": "sve6ac.bty6.com", //站点名"site_size": 0, //站点使用量(M)"site_max": 1, //站点大小(M)"flow_size": 0, //流量(月)使用量(M)"flow_max": 1, //流量(月)大小(M)"sql_size": 0, //数据库使用量(M)"sql_max": 1, //数据库大小"ip_address": "127.0.0.1", //IP地址"ip_addresss": null, //附属IP地址"domain_max": 1, //可绑定域名数"default_analysis": "1", //默认解析地址"is_audit": 1, //域名绑定审核"check_time": null, //最后检查时间"analysis_type": "1", //解析方式及说明"web_back_num": 1, //网站备份数"sql_back_num": 1, //数据库备份数"is_vsftpd": "0", //vsftpd:0=否,1=是"notice": null, //站点备注"createtime": 1597555942,"updatetime": 1598508319,"deletetime": null,"endtime": 1598160664, //站点到期时间"status": "normal" //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常}]}

POST IP绑定

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_bindip
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

失败（201）

复制

{"code": 0,"msg": "已绑定","time": "1598579310","data": null}

成功（200）

复制

{"code": 1,"msg": "绑定成功","time": "1598579343","data": [{"id": 1,"ip": "127.0.0.1","ippools_id": 1,"mask": "255.255.255.0","gateway": "192.168.1.0","createtime": 1597303898,"updatetime": 1597304873,"deletetime": null,"status": "normal", //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常"status_text": "正常"}]}

POST 主机解绑IP

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_unbindip
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

失败（201）

复制

{"code": 0,"msg": "未绑定该IP","time": "1598580234","data": null}

成功（200）

复制

{"code": 1,"msg": "已解除绑定","time": "1598580216","data": [{"id": 1,"ip": "127.0.0.1","ippools_id": 1,"mask": "255.255.255.0","gateway": "192.168.1.0","createtime": 1597303898,"updatetime": 1597304873,"deletetime": null,"status": "normal", //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常"status_text": "正常"}]}

POST 主机转移账号

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_push
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "转移成功","time": "1598508324","data": null}

失败（201）

复制

{"code": 0,"msg": "主机不存在","time": "1598508307","data": null}

POST 主机放入回收站

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_recycle
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "已回收","time": "1598508283","data": null}

失败（201）

复制

{"code": 0,"msg": "主机不存在","time": "1598508294","data": null}

POST 主机回收站恢复

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_recovery
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "已恢复","time": "1598508268","data": null}

POST 关闭限速

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_speedoff
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "已关闭限速","time": "1598492726","data": null}

POST 主机限速

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_speed
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "设置成功","time": "1598492687","data": {"perserver": 300, //限制当前站点最大并发数"limit_rate": 512 //限制每个请求的流量上限（单位：KB）}}

POST 到期时间修改

传递时间的格式请严格按照Y-m-d格式传递，如2020-09-02，如单数月、日，需要补充0，请勿传递2020-9-2格式日期

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_endtime
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "更新成功","time": "1598516711","data": "2020-10-01"}

失败（201）

复制

{"code": 0,"msg": "时间格式错误，请严格按照Y-m-d格式传递","time": "1598516660","data": null}

POST 主机备注修改

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_notice
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "修改成功","time": "1598491505","data": null}

该接口会检查主机资源（站点、数据库、流量）超出后自动停用主机，当主机资源未超出且状态为超量时将恢复主机为正常运行状态并解除超量状态

POST 资源核资

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_resource
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1599988862","data": {"size": {"sqlsize": 0, //数据库使用量(M)"websize": 42.7, //站点使用量(M)"total_size": 0 //流量(月)使用量(M)}, //使用量(M)"max": {"site": 200, //站点大小(M)"flow": 1024, //流量(月)大小(M)"sql": 200 //数据库大小(M)} //大小(M)}}

POST 主机密码修改

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_pass
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598511682","data": {"password": "pDPFnmrXflJk" //新密码}}

自动同步主机ID、到期时间、状态

POST 主机同步

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_sync
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "同步成功","time": "1599990974","data": {"bt_id": 9, //宝塔ID"endtime": "2020-12-31", //站点到期时间"status": 0, //状态:0=停止,1=正常"hostStatus": "stop" //状态:normal=运行,stop=暂停,locked=锁定,expired=过期,excess=超量,error=异常}}

POST 主机锁定

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_locked
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "主机已锁定","time": "1598511958","data": null}

POST 主机停用

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_stop
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "主机已停用","time": "1598511967","data": null}

POST 主机开启

• 接口状态：已完成
• 接口URL：POST {{api_url}}/host_start
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "主机已开启","time": "1598486558","data": null}

主机管理说明

安全验证

已下参数均为公共参数，发起调用时必须，下面文档中将不再提起。

请求示例

https://bthost.yum6.cn/api/vhost/index?time=1598500617&random=SPZJoB&signature=A2F18OXO6UEYS4FSHEP8Q3PLR9OZ4N0Z

注意事项

为了保证API接口通信安全性，签名有效期为10秒，所以需要保证服务器A与服务器B的时间及时区一致，尽可能保证小的误差

1. 将系统时间同步为硬件时间clock && date hwclock --hctosys
2. 先同步服务器网络时间为系统时间，再将系统时间同步为硬件时间yum -y install ntp ntpdate ntpdate cn.pool.ntp.org hwclock --systohc

以上两种方法是同步服务器时间的方法，也可以使用宝塔面板中的Linux工具箱进行时区同步

签名方法

PHP示例

$data['time']   = time();
$data['random'] = mt_rand(); 
$data['token']  = $access_token;    //API通信密钥 自行配置的令牌，不清楚可看概述章节。
sort($data,SORT_STRING);
$str = implode($data);
$signature = md5($str);
$signature = strtoupper($signature);    //最终得到加密后全大写的签名

PHP demo

<?php

$api = 'https://bthost.yum6.cn/api/vhost';      // API地址，bthost.yum6.cn替换自己的域名或IP
$access_token = '55744dsadasd';                 // API通信密钥 自行配置的令牌，不清楚可看概述章节。
$data['time']   = time();
$data['random'] = mt_rand();
$data['token']  = $access_token;
$datas = $data;

sort($data, SORT_STRING);
$str = implode($data);
$signature = md5($str);
$signature = strtoupper($signature);

unset($datas['token']);                          // 安全起见，不传递token参数
$get_data = http_build_query($datas);
$url = $api. '/index?'. $get_data. '&signature='.$signature;
echo file_get_contents($url);

js请求demo

function timest() {
  var tmp = Date.parse( new Date() ).toString();
  tmp = tmp.substr(0,10);
  return tmp;
}

function randomString(e) {  
  e = e || 32;
  var t = "ABCDEFGHJKMNPQRSTWXYZabcdefhijkmnprstwxyz2345678",
  a = t.length,
  n = "";
  for (i = 0; i < e; i++) n += t.charAt(Math.floor(Math.random() * a));
  return n;
}

function implode (glue, pieces) {
  var i = '',
    retVal = '',
    tGlue = '';
  if (arguments.length === 1) {
    pieces = glue;
    glue = '';
  }
  if (typeof pieces === 'object') {
    if (Object.prototype.toString.call(pieces) === '[object Array]') {
      return pieces.join(glue);
    }
    for (i in pieces) {
      retVal += tGlue + pieces[i];
      tGlue = glue;
    }
    return retVal;
  }
  return pieces;
}

$timesss = timest();                    // 时间戳
$randdddd = randomString(6);            // 随机字符
$acctoken = '0VWx31Gd2kc5';             // API通信密钥 自行配置的令牌，不清楚可看概述章节。
$data = [$timesss,$randdddd,$acctoken];
$data.sort();
$str = implode($data);
$signature = $.md5($str);
$signature = $signature.toUpperCase();    //最终得到加密后全大写的签名

IP池类

POST IP地址详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/ipaddress_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598582981","data": {"id": 1, //IP地址ID"ip": "127.0.0.1", //IP地址"ippools_id": 1, //IP地址池ID"mask": "255.255.255.0", //子网掩码"gateway": "192.168.1.0", //网关"createtime": 1597303898,"updatetime": 1597304873,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常"}}

POST IP列表

• 接口状态：已完成
• 接口URL：POST {{api_url}}/ipaddress_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598583011","data": [{"id": 1, //IP地址ID"ip": "127.0.0.1", //IP地址"ippools_id": 1, //IP地址池ID"mask": "255.255.255.0", //子网掩码"gateway": "192.168.1.0", //网关"createtime": 1597303898,"updatetime": 1597304873,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常"}]}

GET IP池列表

• 接口状态：已完成
• 接口URL：GET {{api_url}}/ippools_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598583057","data": [{"id": 1, //IP池ID"name": "测试1", //IP池名称"tag": "test1", //标识"content": "这是测试1的IP池\r\n", //描述"createtime": 1597303276,"updatetime": 1597303276,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常","ip_count": 272, //IP总数"ip_sys": 272 //IP剩余数}]}

GET 测试连接

• 接口状态：已完成
• 接口URL：GET {{api_url}}/index?time={{timeset}}&random={{random_var}}&signature={{signature}}
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Query 请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598515152","data": null}

失败（201）

复制

{"code": 0,"msg": "签名错误","time": "1598515169","data": null}

域名池类

GET 域名池列表

• 接口状态：已完成
• 接口URL：GET {{api_url}}/domainpools_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598508465","data": [{"id": 1, //域名池ID"name": "域名池", //域名池名称"tag": "test2", //标识"content": "域名池", //描述"createtime": 1597304115,"updatetime": 1597304115,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常"}]}

POST 域名列表

• 接口状态：已完成
• 接口URL：POST {{api_url}}/domain_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598508432","data": [{"id": 1, //域名ID"domain": "bty5.com", //域名"domainpools_id": 1, //域名池ID"dnspod": "0", //dnspod智能解析:0=是,1=不是"dnspod_id": 0, //dnspodID"createtime": 1597304582,"updatetime": 1597306376,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"dnspod_text": "Dnspod 0","status_text": "正常"}]}

POST 域名详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/domain_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598508351","data": {"id": 1, //域名ID"domain": "bty5.com", //域名"domainpools_id": 1, //域名池ID"dnspod": "0", //dnspod智能解析:0=是,1=不是"dnspod_id": 0, //dnspodID"createtime": 1597304582,"updatetime": 1597306376,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"dnspod_text": "Dnspod 0","status_text": "正常"}}

资源组分类

POST 资源组详情

• 接口状态：已完成
• 接口URL：POST {{api_url}}/plans_info
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598507462","data": {"id": 1, //资源组ID"name": "默认", //资源组名"value": {"type": "btpanel","name": "默认", //资源组名称"sql": "MySQL", //数据库类型:MySQL,SQLServer"ftp": "1", //开通FTP:0=不开通,1=开通"port": "80", //站点端口，默认80"domain_num": "1", //可绑定域名数:0=无限制"web_back_num": "1", //站点备份数:0=无限制"sql_back_num": "1", //数据库备份数:0=无限制"domainpools_id": "1", //域名池ID"ippools_id": "2", //IP池ID"preset_procedure": "wordpress", //预装程序"phpver": "72", //默认php版本"perserver": "1", //限制并发"limit_rate": "1", //限制单个IP请求网速（KB）"site_max": "1", //站点大小:0=无限制"sql_max": "1", //数据库大小:0=无限制"flow_max": "1", //流量(月):0=无限制"analysis_type": "1", //解析方式及说明"default_analysis": "1", //默认解析地址"domain_audit": "1", //域名绑定审核:0=不审核,1=审核"is_dnspod": "0","session": "0", //session隔离:0=不默认开启,1=默认开启"vsftpd": "0", //vsftp建站:0=不使用,1=使用"sites_path": "" //默认建站目录},"createtime": 1597366074,"updatetime": 1598506747,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常"}}

GET 资源组列表

• 接口状态：已完成
• 接口URL：GET {{api_url}}/plans_list
• Content-Type：multipart/form-data
• 认证方式：无需认证

请求参数

Body 请求参数

响应示例

成功（200）

复制

{"code": 1,"msg": "请求成功","time": "1598506583","data": [{"id": 1, //资源组ID"name": "默认", //资源组名"value": {"type": "btpanel","name": "默认", //资源组名称"sql": "MySQL", //数据库类型:MySQL,SQLServer"ftp": "1", //开通FTP:0=不开通,1=开通"port": "88", //站点端口，默认80"domain_num": "1", //可绑定域名数:0=无限制"web_back_num": "1", //站点备份数:0=无限制"sql_back_num": "1", //数据库备份数:0=无限制"domainpools_id": "1", //域名池ID"ippools_id": "2", //IP池ID"preset_procedure": "", //预装程序"phpver": "72", //默认php版本"perserver": "1", //限制并发"limit_rate": "1", //限制单个IP请求网速（KB）"site_max": "1", //站点大小:0=无限制"sql_max": "1", //数据库大小:0=无限制"flow_max": "1", //流量(月):0=无限制"analysis_type": "1", //解析方式及说明"default_analysis": "1", //默认解析地址"domain_audit": "1", //域名绑定审核:0=不审核,1=审核"is_dnspod": "0","session": "0", //session隔离:0=不默认开启,1=默认开启"vsftpd": "0", //vsftp建站:0=不使用,1=使用"sites_path": "" //默认建站目录},"createtime": 1597366074,"updatetime": 1598357024,"deletetime": null,"status": "normal", //状态:normal=正常,hidden=停用"status_text": "正常"}]}