Skip to content

获取 Web SSH 终端配置(命令补全、终端主题、AI Shell)

获取 Web SSH 终端的当前配置。

POST
https://your-panel.example.com:8888/xterm
查看 Markdown

Request bodyX-WWW-FORM-URLENCODEDrequired

  • request_timestringrequired

    Unix 时间戳;与接口密钥一起生成 request_token。

  • request_tokenstringrequired

    按 API 概览中的双重 MD5 签名算法生成。

  • actionstringrequired

    固定值 completion_tool_status

Returns

default

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

JSON
  • use_completionoptionalboolean

    是否开启命令补全

  • terminal_themeoptionalboolean

    是否使用终端主题

  • ai_shelloptionalboolean

    是否开启 AI Shell

  • ai_shell_analyzeoptionalboolean

    是否开启 AI 分析

各操作详细说明

completion_tool_statusaction=completion_tool_status获取 Web SSH 终端配置(命令补全、终端主题、AI Shell)

获取 Web SSH 终端的当前配置。

  • 路由:POST /xterm
  • action:completion_tool_status

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 completion_tool_status

输出参数

参数名称 类型 描述
use_completion Boolean 是否开启命令补全
terminal_theme Boolean 是否使用终端主题
ai_shell Boolean 是否开启 AI Shell
ai_shell_analyze Boolean 是否开启 AI 分析

示例

{"terminal_theme": false, "use_completion": false, "ai_shell": false, "ai_shell_analyze": false}

set_completion_tool_status

开启或关闭命令补全功能。开启时会从 download.bt.cn 下载补全插件包。

  • 路由:POST /xterm
  • action:set_completion_tool_status

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 set_completion_tool_status
status 是 Integer 1 = 开启,0 = 关闭

输出参数

参数名称 类型 描述
status Boolean true 操作成功
msg String 开启成功 / 关闭成功

示例

action=set_completion_tool_status&status=0
{"status": true, "msg": "关闭成功"}

set_terminal_theme

开启或关闭终端主题。

  • 路由:POST /xterm
  • action:set_terminal_theme

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 set_terminal_theme
status 是 Integer 1 = 开启,0 = 关闭

输出参数

参数名称 类型 描述
status Boolean true
msg String 设置成功

set_ai_shell_status

开启或关闭 AI Shell 功能。

  • 路由:POST /xterm
  • action:set_ai_shell_status

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 set_ai_shell_status
status 是 Integer 1 = 开启,0 = 关闭

输出参数

参数名称 类型 描述
status Boolean true 操作成功
msg String 开启成功 / 关闭成功

set_ai_shell_analyze

开启或关闭 AI 终端分析功能。

  • 路由:POST /xterm
  • action:set_ai_shell_analyze

输入参数

参数名称 必选 类型 描述
action 是 String 固定值 set_ai_shell_analyze
status 是 Integer 1 = 开启,0 = 关闭

输出参数

参数名称 类型 描述
status Boolean true 操作成功
msg String 开启成功 / 关闭成功

get_host_list / get_command_list

获取已保存的 SSH 主机列表和命令历史。

  • 路由:POST /xterm
  • action:get_host_list 或 get_command_list

无额外参数,返回空数组表示无已保存数据。

[]
Navigation

Type to search…

↑↓ navigate↵ selectEsc close