LoCyanFrp API
v2
  • v2
  • v3
主站帮助文档
主站帮助文档
v2
  • v2
  • v3
  1. Minecraft
  • 首页
  • 数据缓存
  • 鉴权说明
  • OAuth2.0 验证流程
  • 鉴权
    • OAuth
      • 获取访问令牌
  • 用户
    • 获取用户信息
      GET
    • 获取用户访问密钥
      GET
  • 隧道
    • 创建隧道
      POST
    • 删除隧道
      DELETE
    • 获取隧道列表
      GET
    • 获取单个隧道状态
      GET
    • 获取隧道配置文件
      GET
    • 强制下线隧道
      POST
    • 更新隧道信息
      POST
  • 签到
    • 获取签到状态
      GET
    • 签到
      POST
  • 通知
    • 获取公告
      GET
  • 节点
    • 列出全部可用节点
      GET
    • 获取节点统计信息
      GET
    • 获取随机隧道端口
      GET
  • 身份认证
    • 获取认证状态
  • ICP
    • 工信部
      • 获取验证码图片
      • 提交验证码点位获取人机验证 Sign
    • 添加 ICP 备案记录
    • 移除 ICP 备案记录
    • 获取已登记 ICP 备案列表
  • Minecraft
    • 获取 Minecraft 服务器状态
      GET
    • 获取 Minecraft 游戏连接信息
      GET
    • 创建 Minecraft 联机房间
      POST
    • 删除 Minecraft 联机房间
      DELETE
    • 获取用户全部 Minecraft 游戏
      GET
  • 软件
    • 获取 Frp 版本列表
  • 连接
  1. Minecraft

获取 Minecraft 服务器状态

GET
https://api.locyanfrp.cn/v2/minecraft/status
edition:0 代表 Java 版,1 代表基岩版
port:不填 Java 版默认 25565,基岩版默认 19132
当端口为空时,editon 为 0 将会优先尝试解析 SRV 记录
SRV 记录只取解析出的前三个记录进行尝试,避免过长的响应时长

请求参数

Query 参数
host
string 
服务器主机名
必需
port
integer 
服务器端口
可选
edition
integer 
服务器类型
必需
示例值:
0

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.locyanfrp.cn/v2/minecraft/status?host&port&edition=0'

返回响应

🟢200成功
application/json
Java 版返回
Body
message
string 
返回消息
必需
status
integer 
状态
必需
默认值:
200
data
object 
返回数据
必需
delay
integer 
延迟
必需
mod
object 
服务器Mod
必需
description
string 
MOTD
必需
server_mod
string 
服务器核心
必需
version
object 
版本
必需
status
string 
在线状态
必需
player
object 
玩家
必需
示例
{
    "data": {
        "delay": 18,
        "mod": {
            "count": 0,
            "list": []
        },
        "description": "\nAwA",
        "server_mod": "Vanilla",
        "version": {
            "protocol": 4,
            "name": "Velocity 1.7.2-1.21"
        },
        "status": "online",
        "player": {
            "max": 233,
            "online": 0
        }
    },
    "message": "OK",
    "status": 200
}
🟢200成功
修改于 2024-09-30 11:27:52
上一页
获取已登记 ICP 备案列表
下一页
获取 Minecraft 游戏连接信息
Built with