API: HTTP

通用参数

API 地址: /api/*?token=<token>&type=<type>&msg=<msg>

参数	值	用途
token	任意字符串	Manager 的 Token
type (可选)	任意字符串	此操作的类型
msg (可选)	任意字符串	此操作的解释

注意! 当 type 与 msg 同时存在时才会记录进入数据库.

通用返回值

返回类型: JSON

{
    "code": 200,
    "type": "bds",
    "msg": "OK",
    "content": []
}

名称	类型	用途
code	数字	状态码
type	任意字符串	类型
msg	任意字符串	简要描述, 常见 OK
content	任意类型	返回值的主要内容

当鉴权失败时:

名称	类型	值
code	Int	401
type	String	"auth"
msg	String	"Unauthorized operation"

命令

执行命令

发送一段命令给 Bedorck Server 并获得执行结果.
API 地址: /api/cmd/<cmd>?token=<token>&line=<line>

参数	类型	用途
cmd	任意字符串,支持特殊符号及空格	发送给 Bedrock Server 执行的命令
line	任意非负整数	指定时读取到 line 行输出内容并返回读取到的执行结果, 无需执行结果时可指定 0.
ignore (可选)	布尔值(true/false)	当指定 ignore=true 时, 通过此 API 执行的命令及其结果将不保留在数据库内
timeout (可选)	整数	等待读取到 line 行日志的最长时间, 当指定 0 时将一直等待

返回值:

名称	类型	值
code	Int	200
type	String	"cmd_log"
msg	String	"OK"
content	Array	命令执行结果

示例:

• http://127.0.0.1:5500/api/cmd/list?token=debug&line=2 获取服务器在线玩家
• http://127.0.0.1:5500/api/cmd/stop?token=debug&line=1&timeout=0 停止 Bedrock Server 并等待其完全停止
• http://127.0.0.1:5500/api/cmd/restart?token=debug&line=0 重新启动 Bedrock Server
• http://127.0.0.1:5500/api/cmd/list?token=debug&line=2&type=tg_bot&msg=require%20%27list%27%20by%20gggxbbb
  (/api/cmd/list?token=debug&line=2&type=tg_bot&msg=require 'list' by gggxbbb)
  Tg 用户 gggxbbb 通过 Tg 机器人请求服务器告知在线的玩家.
• http://127.0.0.1:5500/api/cmd/whitelist%20add%20gggxbbb?token=debug&line=1&type=tg_bot&msg=add%20%27gggxbbb%27%20to%20whitelist%20by%20114514
  (/api/cmd/whitelist add gggxbbb?token=debug&line=1&type=tg_bot&msg=add 'gggxbbb' to whitelist by 114514)
  Tg ID 为 114514 的用户 通过 Tg 机器人添加 Xbox ID 为 gggxbbb 的玩家到服务器白名单.

日志

写日志

非建议使用的 API, 相关日志记录建议参考 通用参数
向数据库中写入日志.
API 地址: /api/log/put/<type>/<log>?token=<token>

参数	类型	用途
type	任意字符串	日志的类型
log	任意字符串	日志的内容

返回值:

名称	类型	值
code	Int	200
type	String	"log_put"
msg	String	"OK"
content	String	"OK"

获取所有类型的日志

API 地址:

• /api/log/all?token=<token> (获取所有)
• /api/log/all/<length>?token=<token> (指定数量)

参数	类型	用途
length (可选)	任意正整数	指定获取日志的行数, 从新到旧

返回值:

• 正常返回:

  名称	类型	值
  code	Int	200
  type	String	"log_<type>"
  msg	String	"OK"
  content	Array	指定的日志

• 无法找到对应的日志:

  名称	类型	值
  code	Int	404
  type	String	"log_<type>"
  msg	String	"No such type"
  content		Null

获取指定类型的日志

API 地址:

• /api/log/type/<type>?token=<token> (获取所有)
• /api/log/type/<type>/<length>?token=<token> (指定数量)

参数	类型	用途
type	任意字符	所需日志的类型
length (可选)	任意正整数	指定获取日志的行数, 从新到旧

返回值:

• 正常返回:

  名称	类型	值
  code	Int	200
  type	String	"log_<type>"
  msg	String	"OK"
  content	Array	指定的日志

• 无法找到对应的日志:

  名称	类型	值
  code	Int	404
  type	String	"log_<type>"
  msg	String	"No such type"
  content		Null

Manager 配置

非建议使用的 API

Bedrock Server 配置

非建议使用的 API