跳到正文
Navigation

为网站创建反向代理规则

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

为指定网站创建反向代理,将指定路径的请求转发到后端服务。

Request body application/x-www-form-urlencoded required

  • request_time
    string
    required

    Unix 时间戳。

  • request_token
    string
    required

    按 API 概览生成的签名。

  • action
    CreateProxy
    required

    具体操作名称。

  • sitename
    string
    required

    网站域名(注意小写)

  • proxyname
    string
    required

    代理名称(3~40 字节)

  • proxydir
    string
    required

    代理目录路径,如 /api 或 /

  • proxysite
    string
    required

    目标 URL,如 http://127.0.0.1:8080

  • type
    string
    required

    类型:"1" 启用

  • cache
    string
    required

    "1" 启用缓存 / "0" 禁用

  • cachetime
    string
    required

    缓存时间(分钟),禁用缓存时传 "0"

  • todomain
    string
    required

    目标域名($host 值),填网站域名即可

  • subfilter
    string
    required

    JSON 数组,内容替换规则 [{"sub1":"旧","sub2":"新"},...]

  • advanced
    string
    required

    高级模式:"1" / "0"

Returns

default

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

JSON
  • status
    optional
    boolean

    true 添加成功

  • msg
    optional
    string

    添加成功

各操作详细说明

CreateProxyaction=CreateProxy为网站创建反向代理规则

为指定网站创建反向代理,将指定路径的请求转发到后端服务。

  • 路由:POST /site
  • action:CreateProxy

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 CreateProxy
sitename 是 String 网站域名(注意小写)
proxyname 是 String 代理名称(3~40 字节)
proxydir 是 String 代理目录路径,如 /api 或 /
proxysite 是 String 目标 URL,如 http://127.0.0.1:8080
type 是 String 类型:"1" 启用
cache 是 String "1" 启用缓存 / "0" 禁用
cachetime 是 String 缓存时间(分钟),禁用缓存时传 "0"
todomain 是 String 目标域名($host 值),填网站域名即可
subfilter 是 String JSON 数组,内容替换规则 [{"sub1":"旧","sub2":"新"},...]
advanced 是 String 高级模式:"1" / "0"

输出参数

参数名称 类型 描述
status Boolean true 添加成功
msg String 添加成功

示例

请求

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

action=CreateProxy&sitename=testapi.bt.local&proxyname=api_proxy&proxydir=/api&proxysite=http://127.0.0.1:9090&type=1&cache=0&cachetime=0&todomain=testapi.bt.local&subfilter=[{"sub1":"","sub2":""},{"sub1":"","sub2":""},{"sub1":"","sub2":""}]&advanced=0

响应

{"status": true, "msg": "添加成功"}

相关接口

Type to search…

↑↓ navigate↵ selectEsc close