宝塔面板官方文档

获取网站的免费流量限制状态

查询指定网站或全局的免费流量限制开关状态。

POST

https://your-panel.example.com:8888/site

更新于 2026年7月10日查看 Markdown

Request bodyX-WWW-FORM-URLENCODEDrequired

request_timestringrequired
Unix 时间戳。
request_tokenstringrequired
按 API 概览生成的签名。
actionget_free_total_statusrequired
具体操作名称。
site_idstringrequired
网站 ID，传 "global" 查询全局

Returns

default

接口响应，业务状态见下方详细说明。

JSON

statusoptionalboolean
true 查询成功
dataoptionalobject
{"status": true/false}
msgoptionalstring
结果消息

各操作详细说明

get_free_total_statusaction=get_free_total_status获取网站的免费流量限制状态

查询指定网站或全局的免费流量限制开关状态。

路由：POST /site
action：get_free_total_status

输入参数

参数名称	必选	类型	描述
action	是	String	固定值 `get_free_total_status`
site_id	是	String	网站 ID，传 `"global"` 查询全局

输出参数

参数名称	类型	描述
status	Boolean	`true` 查询成功
data	Object	`{"status": true/false}`
msg	String	结果消息

示例

请求

POST /site HTTP/1.1
Host: 192.168.168.213:8888
Content-Type: application/x-www-form-urlencoded

action=get_free_total_status&site_id=1

响应

{"status": true, "data": {"status": true}, "msg": "获取成功"}

相关接口

set_free_total_status — 设置状态

获取网站的免费流量限制状态

curl --request POST \
  --url "https://your-panel.example.com:8888/site" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "request_time=<Unix时间戳>" \
  --data-urlencode "request_token=<按 API 概览生成的签名>" \
  --data-urlencode "action=get_free_total_status" \
  --data-urlencode "site_id=<site_id>"

Response example

{
  "status": true,
  "data": {
    "status": true
  },
  "msg": "获取成功"
}