宝塔 Linux 面板 API 文档前言通过宝塔 API, 可以完全控制宝塔 Linux 面板的所有功能, 包括第三方插件应用功能, 事实上, 在用户登录面板后使用的所有功能也是通过相同的接口对接的, 这意味着, 如果你熟悉使用浏览器调试器, 就可以轻松对照宝塔 Linux 面板的操作参数完成

Size: px

Start display at page:

Download "宝塔 Linux 面板 API 文档前言通过宝塔 API, 可以完全控制宝塔 Linux 面板的所有功能, 包括第三方插件应用功能, 事实上, 在用户登录面板后使用的所有功能也是通过相同的接口对接的, 这意味着, 如果你熟悉使用浏览器调试器, 就可以轻松对照宝塔 Linux 面板的操作参数完成"

坡允詹
5 years ago
Views:

1 宝塔 Linux 面板 API 文档前言通过宝塔 API, 可以完全控制宝塔 Linux 面板的所有功能, 包括第三方插件应用功能, 事实上, 在用户登录面板后使用的所有功能也是通过相同的接口对接的, 这意味着, 如果你熟悉使用浏览器调试器, 就可以轻松对照宝塔 Linux 面板的操作参数完成一个第三方的前端对接签名算法 api_sk = 接口密钥 ( 在面板设置页面 - API 接口中获取 ) request_time = 当前请求时间的 uinx 时间戳 ( php: time() / python: time.time() ) request_token = md5(string(request_time) + md5(api_sk)) PHP 示例 : $request_token = md5($request_time.. md5($api_sk)) 签名 : request_time 当前 uinx 时间戳 [ 必传 ] request_token md5(string(request_time) + md5(api_sk)) [ 必传 ] 其它参数功能接口需要的其它参数 [ 可选 ] 注意事项 : 1 请统一使用 POST 方式请求 API 接口 2 为了确保请求效率, 请保存 cookie, 并在每次请求时附上 cookie 3 为了面板安全考虑, 请务必添加 IP 白名单 4 所有响应内容统一为 Json 数据格式 DEMO 下载 PHP-Demo:

2 系统状态相关接口获取系统基础统计 URI 地址 :/system?action=getsystemtotal 无 system CentOS Linux (Core) 操作系统信息 version 面板版本 time 0 天 23 小时 45 分钟上次开机到现在经过的时间 cpunum 2 CPU 核心数 cpurealused 2.01 CPU 使用率 ( 百分比 ) memtotal 1024 物理内存容量 (MB) memrealused 300 已使用的物理内存 (MB) memfree 724 可用的物理内存 (MB) memcached 700 缓存化的内存 (MB) membuffers 100 系统缓冲 (MB) "cpurealused": 0.85, "memtotal": 1741, "system": "CentOS Linux (Core)", "memrealused": 691, "cpunum": 6, "memfree": 189, "version": "6.8.1", "time": "0\u592923\u5c0f\u65f657\u5206\u949f", "memcached": 722, "membuffers": 139, "isuser": 0 获取磁盘分区信息 URI 地址 :/system?action=getdiskinfo 无字段字段值示例说明 [].path / 分区挂载点 [].inodes [" ", "148216", " ", "2%"] 分区 Inode 使用信息 [ 总量, 已使用, 可用, 使用率 ] [].size ["8.3G", "4.0G", "4.3G", "49%"] 分区容量使用信息 [ 总量, 已使用, 可用, 使用率 ] [ "path": "/", "inodes": [" ", "148216", " ", "2%"], "size": ["8.3G", "4.0G", "4.3G", "49%"],

3 ] "path": "/www", "inodes": ["655360", "295093", "360267", "46%"], "size": ["9.8G", "3.7G", "5.6G", "40%"] 获取实时状态信息 (CPU 内存网络负载) URI 地址 :/system?action=getnetwork 无 downtotal 总接收 ( 字节数 ) uptotal 总发送 ( 字节数 ) downpackets 总收包 ( 个 ) uppackets 总发包 ( 个 ) down 下行流量 (KB) up 上行流量 (KB) cpu [1.87, 6] CPU 实时信息 [ 使用率, 核心数 ] mem memfree: 189, memtotal: 1741, memcached: 内存实时信息 722, membuffers: 139, memrealused: 691 load max: 12, safe: 9, one: 0, five: 0.01, limit: 12, fifteen: 0.05 负载实时信息 one: 1 分钟 five: 5 分钟 fifteen: 10 分钟 "load": "max": 12, "safe": 9.0, "one": 0.01, "five": 0.02, "limit": 12, "fifteen": 0.05, "down": 8.77, "downtotal": , "mem": "memfree": 189, "memtotal": 1741, "memcached": 722, "membuffers": 140, "memrealused": 690, "up": 4.33, "uptotal": , "uppackets": , "downpackets": , "cpu": [0.23, 6] 检查是否有安装任务 URI 地址 :/ajax?action=gettaskcount 无 0

4 检查面板更新 URI 地址 :/ajax?action=updatepanel check true 强制检查更新 [ 可选 ] force true 执行更新 [ 可选 ] status true 获取状态 true false version 最新版本号 updatemsg string 升级说明 "version": "6.8.2", "updatemsg": " 升级说明 " 网站管理获取网站列表 URI 地址 :/data?action=getdata&table=sites p 1 当前分页 [ 可选 ] limit 15 取回的数据行数 [ 必传 ] type -1 分类标识, -1: 分部分类 0: 默认分类 [ 可选 ] order id desc 排序规则使用 id 降序 :id desc 使用名称升序 :name desc [ 可选 ] tojs get_site_list 分页 JS 回调, 若不传则构造 URI 分页连接 [ 可选 ] search www 搜索内容 [ 可选 ] data [] 网站列表数据 page 分页数据 where type_id=0 数据查询条件 "data": [ "status": "1", "ps": "bbb.com",

5 "domain": 1, "name": "bbb.com", "addtime": " :14:03", "path": "/www/wwwroot/bbb.com", "backup_count": 0, "edate": " ", "id": 64 ], "where": "type_id=0", "page": "<div><span class='pcurrent'>1</span><span class='pcount'>\u51711\u6761\u6570\u636e</span></div>" 获取网站分类 URI 地址 :/site?action=get_site_types 空 [ "id": 0, "name": "\u9ed8\u8ba4\u5206\u7c7b" ] 获取已安装的 PHP 版本列表 URI 地址 :/site?action=getphpversion 空 [ "version": "00", "name": "\u7eaf\u9759\u6001", "version": "56", "name": "PHP-56", "version": "72", "name": "PHP-72" ] 创建网站 URI 地址 :/site?action=addsite webname "domain":"w1.hao.com","domainlist":[],"count":0 网站主域名和域名列表请传 JSON [ 必传 ] path /www/wwwroot/w1.hao.com 根目录 [ 必传 ] type_id 0 分类标识 [ 必传 ] type PHP 项目类型请传 PHP [ 必传 ] version 72 PHP 版本请从 PHP 版本列表中选择 [ 必传 ] port 80 网站端口 [ 必传 ] ps 测试网站备注 ftp true false 是否创建 FTP [ 必传 ] ftp_username w1_hao_com FTP 用户名在要创建 FTP 时必传 ftp_password WCBZ6cH87raERzXc FTP 密码在要创建 FTP 时必传

6 sql true false 是否创建数据库 [ 必传 ] codeing utf8 utf8mb4 gbk big5 数据库字符集在要创建数据库时必传 datauser w1_hao_com 数据库用户名及名称在要创建数据库时必传 datapassword PdbNjJy5hBA346AR 数据库密码在要创建数据库时必传 sitestatus true false 网站是否创建成功 ftpstatus true false FTP 是否创建成功 ftpuser w2_hao_com FTP 用户名 ftppass srxmy6xcn6zesftg FTP 密码 databasestatus true false 数据库是否创建成功 databaseuser w2_hao_com 数据库用户名和名称 databasepass PdbNjJy5hBA346AR 数据库密码 "ftpstatus": true, "databaseuser": "w2_hao_com", "databasestatus": true, "ftpuser": "w2_hao_com", "databasepass": "PdbNjJy5hBA346AR", "sitestatus": true, "ftppass": "srxmy6xcn6zesftg" 删除网站 URI 地址 :/site?action=deletesite webname w2_hao_com 网站名称 [ 必传 ] ftp 1 是否删除关联 FTP, 如果不删除请不要传此参数 [ 可选 ] database 1 是否删除关联数据库, 如果不删除请不要传此参数 [ 可选 ] path 1 是否删除网站根目录, 如果不删除请不要传此参数 [ 可选 ] status true false 是否操作成功 msg 删除成功! 提示内容 "msg": "\u7ad9\u70b9\u5220\u9664\u6210\u529f!"

7 停用网站 URI 地址 :/site?action=sitestop name w2.hao.com 网站名称 ( 主域名 ) [ 必传 ] "msg": "\u7ad9\u70b9\u5220\u9664\u6210\u529f!" 启用网站 URI 地址 :/site?action=sitestart name w2.hao.com 网站名称 ( 主域名 ) [ 必传 ] "msg": "\u7ad9\u70b9\u5df2\u542f\u7528" 网站到期时间 URI 地址 :/site?action=setedate edate 到期时间永久 : [ 必传 ] "msg": "\u7ad9\u70b9\u5df2\u542f\u7528" 修改网站备注 URI 地址 :/data?action=setps&table=sites ps 测试备注内容 [ 必传 ]

8 "msg": "\u4fee\u6539\u6210\u529f" 获取网站备份列表 URI 地址 :/data?action=getdata&table=backup p 1 当前分页 [ 可选 ] limit 5 每页取回的数据行数 [ 必传 ] type 0 备份类型, 请固定传 0 [ 必传 ] tojs get_site_backup 分页 JS 回调, 若不传则构造 URI 分页连接 [ 可选 ] search 66 网站 ID [ 必传 ] data [] 备份列表数据 page 分页数据 where type_id=0 数据查询条件 "data": [], "where": "pid=65 and type='0'", "page": "<div><span class='pcurrent'>1</span><span class='pcount'>\u51710\u6761\u6570\u636e</span></div>" 创建网站备份 URI 地址 :/site?action=tobackup "msg": "\u5907\u4efd\u6210\u529f!" 删删网站备份 URI 地址 :/site?action=delbackup

9 参数名称参数值说明 id 121 备份列表 ID [ 必传 ] "msg": "\u5220\u9664\u6210\u529f" 获取网站的域名列表 URI 地址 :/data?action=getdata&table=domain search 66 网站 ID [ 必传 ] list true 请固定传 true [ 必传 ] [ "port": 80, "addtime": " :57:30", "pid": 65, "id": 73, "name": "w1.hao.com" ] 添加域名 URI 地址 :/site?action=adddomain webname w2.hao.com 网站名称 [ 必传 ] domain w4.hao.com:81 要添加的域名 : 端口 80 端品不必构造端口, 多个域名用换行符隔开 [ 必传 ] "msg": "\u57df\u540d\u6dfb\u52a0\u6210\u529f!" 删除域名 URI 地址 :/site?action=deldomain 参数名称参数值示例说明

10 webname w2.hao.com 网站名称 [ 必传 ] domain w4.hao.com 要被删除的域名 [ 必传 ] port 80 该域名的端口 [ 必传 ] "msg": "\u5220\u9664\u6210\u529f" 获取可选的预定义伪静态列表 URI 地址 :/site?action=getrewritelist sitename w2.hao.com 网站名称 [ 必传 ] 字段字段值示例说明 rewrite [] 预定义伪静态列表 "rewrite": ["0.\u5f53\u524d", "EmpireCMS", "dabr", "dbshop", "dedecms", "default", "discuz", "discuzx", "discuzx2", "discuzx3", "drupal", "ecshop", "emlog", "laravel5", "maccms", "mvc", "niushop", "phpcms", "phpwind", "sablog", "seacms", "shopex", "thinkphp", "typecho", "typecho2", "weengine", "wordpress", "wp2", "zblog"] 获取指定预定义伪静态规则内容 ( 获取文件内容 ) URI 地址 :/files?action=getfilebody path /www/server/panel/rewrite/nginx/ 名称.conf 要被获取的文件 [ 必传 ] 保存伪静态规则内容 ( 保存文件内容 ) URI 地址 :/files?action=savefilebody path /www/server/panel/rewrite/nginx/ 名称.conf 保存位置 [ 必传 ] data 规则内容 encoding utf-8 文件编码请固定传 utf-8

11 未完待续

public 公共库引用 :import public 读取文件 filename 文件名 [ 必传 ] mode 文件打开模式默认 r bool f_body = public.readfile(filename,mode='r') 写入文件 #

public 公共库引用 :import public 读取文件 filename 文件名 [ 必传 ] mode 文件打开模式默认 r bool f_body = public.readfile(filename,mode='r') 写入文件 # 宝塔 Linux 面板插件开发文档插件安装位置 :/www/server/panel/plugin/ 文件结构 : demo_main.py 插件后端主程序 ( 插件名称 _main.py) index.html 插件前端程序 info.json 插件信息文件 icon.png 插件图标文件 install.sh 安装卸载脚本插件名称 _main.py 内容格式以插件名称为 demo 示例 :