API接口使用教程

启用（/site?action=SiteStart）、停用网站（/site?action=SiteStop）的API报以下错误，其他的API接口没问题。

<h1>抱歉,程序异常</h1>
<p>您请求的页面因发生异常而中断!</p>

希望宝塔尽快完善API文档，有一些接口会返回一些API文档上没有标注过的新参数！希望宝塔尽快完善API文档！

有个问题，请教下各位大神，我在用python去添加网站的时候总是报500错误，其他像获取系统信息，获取LOG日志等都正常的。python文件如下,python本版：3.7.0

1. #coding: utf-8
   
2. # +-------------------------------------------------------------------
   
3. # | 宝塔Linux面板
   
4. # +-------------------------------------------------------------------
   
5. # | Copyright (c) 2015-2099 宝塔软件() All rights reserved.
   
6. # +-------------------------------------------------------------------
   
7. # | Author: 黄文良 <2879625666@qq.com>
   
8. # +-------------------------------------------------------------------
   
9. 
   
10. #------------------------------
    
11. # API-Demo of Python
    
12. #------------------------------
    
13. import time,hashlib,sys,os,json
    
14. class bt_api:
    
15.     __BT_KEY = '***'
    
16.     __BT_PANEL = '***'
    
17. 
    
18.     #如果希望多台面板，可以在实例化对象时，将面板地址与密钥传入
    
19.     def __init__(self,bt_panel = None,bt_key = None):
    
20.         if bt_panel:
    
21.             self.__BT_PANEL = bt_panel
    
22.             self.__BT_KEY = bt_key
    
23. 
    
24. 
    
25.     #取面板日志
    
26.     def get_logs(self):
    
27.         #拼接URL地址
    
28.         url = self.__BT_PANEL + '/data?action=getData'
    
29. 
    
30.         #准备POST数据
    
31.         p_data = self.__get_key_data()  #取签名
    
32.         p_data['table'] = 'logs'
    
33.         p_data['limit'] = 10
    
34.         p_data['tojs'] = 'test'
    
35. 
    
36.         #请求面板接口
    
37.         result = self.__http_post_cookie(url,p_data)
    
38. 
    
39.         #解析JSON数据
    
40.         return json.loads(result)
    
41. 
    
42.     #取系统状态
    
43.     def sysstatus(self):
    
44.         #拼接URL地址
    
45.         url = self.__BT_PANEL + '/system?action=GetSystemTotal'
    
46. 
    
47.         #准备POST数据
    
48.         p_data = self.__get_key_data()  #取签名
    
49.         #请求面板接口
    
50.         result = self.__http_post_cookie(url,p_data)
    
51. 
    
52.         #解析JSON数据
    
53.         return json.loads(result)
    
54.     #获取磁盘信息
    
55.     def diskinfo(self):
    
56.         #拼接URL地址
    
57.         url = self.__BT_PANEL + '/system?action=GetDiskInfo'
    
58. 
    
59.         #准备POST数据
    
60.         p_data = self.__get_key_data()  #取签名
    
61.         #请求面板接口
    
62.         result = self.__http_post_cookie(url,p_data)
    
63. 
    
64.         #解析JSON数据
    
65.         return json.loads(result)
    
66. 
    
67. 
    
68.     def addsite(self):
    
69.         #拼接URL地址
    
70.         url = self.__BT_PANEL + '/site?action=AddSite'
    
71. 
    
72.         #准备POST数据
    
73.         p_data = self.__get_key_data()  #取签名
    
74.         # p_data['tojs'] = 'test'
    
75.         # p_data={}
    
76.         p_data['webname'] = {"domain":'test.com',"domainlist":[],"count":0}
    
77.         p_data['path'] = '/www/wwwroot/test.com'
    
78.         p_data['type_id'] = 0
    
79.         p_data['type'] = 'PHP'
    
80.         p_data['version'] = 72
    
81.         p_data['port'] = 80
    
82.         p_data['ps'] = 'test'
    
83.         p_data['ftp'] = False
    
84.         p_data['ftp_username'] = 'testtest'
    
85.         p_data['ftp_password'] = 'testtest'
    
86.         p_data['sql'] = False
    
87.         p_data['coding'] = 'utf8'
    
88.         p_data['datauser'] = 'testtest'
    
89.         p_data['datapassword'] = 'testtesttesttest'
    
90.         #请求面板接口
    
91.         result = self.__http_post_cookie(url,p_data)
    
92. 
    
93.         #解析JSON数据
    
94.         return json.loads(result)
    
95. 
    
96.     #计算MD5
    
97.     def __get_md5(self,s):
    
98.         m = hashlib.md5()
    
99.         m.update(s.encode('utf-8'))
    
100.         return m.hexdigest()
     
101. 
     
102.     #构造带有签名的关联数组
     
103.     def __get_key_data(self):
     
104.         now_time = int(time.time())
     
105.         p_data = {
     
106.                     'request_token':self.__get_md5(str(now_time) + '' + self.__get_md5(self.__BT_KEY)),
     
107.                     'request_time':now_time
     
108.                  }
     
109.         return p_data
     
110. 
     
111. 
     
112.     #发送POST请求并保存Cookie
     
113.     #@url 被请求的URL地址(必需)
     
114.     #@data POST参数，可以是字符串或字典(必需)
     
115.     #@timeout 超时时间默认1800秒
     
116.     #return string
     
117.     def __http_post_cookie(self,url,p_data,timeout=18000):
     
118.         cookie_file = './' + self.__get_md5(self.__BT_PANEL) + '.cookie'
     
119.         with open(cookie_file,"a") as file:
     
120.             file.write("# Netscape HTTP Cookie File\n")
     
121.         if sys.version_info[0] == 2:
     
122.             #Python2
     
123.             import urllib,urllib2,ssl,cookielib
     
124. 
     
125.             #创建cookie对象
     
126.             cookie_obj = cookielib.MozillaCookieJar(cookie_file)
     
127. 
     
128.             #加载已保存的cookie
     
129.             if os.path.exists(cookie_file):cookie_obj.load(cookie_file,ignore_discard=True,ignore_expires=True)
     
130. 
     
131.             ssl._create_default_https_context = ssl._create_unverified_context
     
132. 
     
133.             data = urllib.urlencode(p_data)
     
134.             req = urllib2.Request(url, data)
     
135.             opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cookie_obj))
     
136.             response = opener.open(req,timeout=timeout)
     
137. 
     
138.             #保存cookie
     
139.             cookie_obj.save(ignore_discard=True, ignore_expires=True)
     
140.             return response.read()
     
141.         else:
     
142.             #Python3
     
143.             import urllib.request,ssl,http.cookiejar
     
144.             cookie_obj = http.cookiejar.MozillaCookieJar(cookie_file)
     
145.             if os.path.exists(cookie_file):
     
146.                 cookie_obj.load(cookie_file,ignore_discard=True,ignore_expires=True)
     
147.             # cookie_obj.load(cookie_file,ignore_discard=True,ignore_expires=True)
     
148.             handler = urllib.request.HTTPCookieProcessor(cookie_obj)
     
149.             data = urllib.parse.urlencode(p_data).encode('utf-8')
     
150.             print(data)
     
151.             req = urllib.request.Request(url, data)
     
152.             opener = urllib.request.build_opener(handler)
     
153.             response = opener.open(req,timeout = timeout)
     
154.             cookie_obj.save(ignore_discard=True, ignore_expires=True)
     
155.             result = response.read()
     
156.             if type(result) == bytes: result = result.decode('utf-8')
     
157.             return result
     
158. 
     
159. 
     
160. if __name__ == '__main__':
     
161.     #实例化宝塔API对象
     
162.     my_api = bt_api()
     
163.     domain = 'test.laojihost.com'
     
164.     username = str(domain)[0-15]
     
165.     # 调用get_logs方法
     
166.     r_data = my_api.get_logs()
     
167.     # r_sys = my_api.sysstatus()
     
168.     # r_disk = my_api.diskinfo()
     
169.     r_add_site = my_api.addsite()
     
170.     #打印响应数据
     
171.     print(r_data)
     
172.     # print(r_sys)
     
173.     # print(r_disk)
     
174.     print(r_add_site)
     

复制代码

运行报错如下：

1. Traceback (most recent call last):
   
2.   File "demo.py", line 169, in <module>
   
3.     r_add_site = my_api.addsite()
   
4.   File "demo.py", line 91, in addsite
   
5.     result = self.__http_post_cookie(url,p_data)
   
6.   File "demo.py", line 136, in __http_post_cookie
   
7.     response = opener.open(req,timeout=timeout)
   
8.   File "/usr/lib64/python2.7/urllib2.py", line 437, in open
   
9.     response = meth(req, response)
   
10.   File "/usr/lib64/python2.7/urllib2.py", line 550, in http_response
    
11.     'http', request, response, code, msg, hdrs)
    
12.   File "/usr/lib64/python2.7/urllib2.py", line 475, in error
    
13.     return self._call_chain(*args)
    
14.   File "/usr/lib64/python2.7/urllib2.py", line 409, in _call_chain
    
15.     result = func(*args)
    
16.   File "/usr/lib64/python2.7/urllib2.py", line 558, in http_error_default
    
17.     raise HTTPError(req.get_full_url(), code, msg, hdrs, fp)
    
18. urllib2.HTTPError: HTTP Error 500: INTERNAL SERVER ERROR

复制代码

有安全里的屏蔽IP的接口吗？

IP校验失败,您的访问IP为

楼主，我配置了api ip白名单还是返回IP校验失败,您的访问IP为....有可能是什么问题

反向代理考虑下啊,这样就可以拿宝塔做cdn了

api的pdf文档加个目录，方便一眼能看到api都有哪些功能，也便于开发者一目了然的知道是否能实现自己的需求

镖客若水 发表于 2019-9-10 16:57
windows什么时候能提供啊

本机测试，已经可以了使用这个API了

计划任务什么时候有接口，接口文档都两年还没有出网页版吗

"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2 Final//EN\">\n<title>Redirecting...</title>\n<h1>Redirecting...</h1>\n<p>You should be redirected automatically to target URL: <a href=\"/login\">/login</a>.  If not click the link.",
出现这种情况后我的原因是没有传递文档中签名算法的接口参数request_time和request_token,加上参数就好了；还有可能是因为没有在面板设置的APi接口中配置ip白名单。

宝塔用户_cetjla 发表于 2020-4-11 11:35
有个问题，请教下各位大神，我在用python去添加网站的时候总是报500错误，其他像获取系统信息，获取LOG日志 ...

addsite中数据提交格式：
    def addsite(self):
         # 拼接URL地址
        url = self.__BT_PANEL + '/site?action=AddSite'

         # 准备POST数据
        p_data = self.__get_key_data()  # 取签名
        # p_data['tojs'] = 'test'
         # p_data={}
         p_data['webname'] = json.dumps({'domain': '', 'domainlist': [''], 'count': 0})  
         p_data['path'] = '/www/wwwroot/abc.com'
         p_data['type_id'] = '0'
         p_data['type'] = 'PHP'
         p_data['version'] = '00'
         p_data['port'] = '80'
         p_data['ps'] = 'test'
         p_data['ftp'] = "False"
         p_data['ftp_username'] = 'testtest'
         p_data['ftp_password'] = 'testtest'
         p_data['sql'] = "FALSE"
         p_data['codeing'] = 'utf8'
         p_data['datauser'] = 'testtest'
         p_data['datapassword'] = 'testtesttesttest'
         # 请求面板接口
        result = self.__http_post_cookie(url, p_data)

         # 解析JSON数据
        return json.loads(result)

删除域名老是提示请选择域名是什么情况

CNAME解析后，进行网站子目录绑定。绑定成功后只返回{"status": true, "msg": "\u6dfb\u52a0\u6210\u529f"}这个。可是不返回id，怎么进行后面的删除呢？？或者怎么获取添加的这个子目录绑定网站的id呢？？

您好，调用接口提示{"status": false, "msg": "指定参数无效!"}
请求的接口是/data?action=GetSystemTotal
这个都没有入参，怎么会提示指定参数无效呢，其中request_token和request_time绝对没有错