service-status

2. `/service-status` - 服务状态信息

{
  "code": 0,
  "msg": "success",
  "data": {
    "version": "2.1.0",
    "addr": "0.0.0.0:8765",
    "config_sources": ["config.yml", "命令行参数"],
    "config": {
      "addr": "0.0.0.0:8765",
      "offset": 100,
      "poll": 50
    },
    "endpoints": {
      "ws": "ws://0.0.0.0:8765/ws",
      "health-check": "http://0.0.0.0:8765/health-check",
      "service-status": "http://0.0.0.0:8765/service-status",
      "all_lyrics": "http://0.0.0.0:8765/all_lyrics",
      "lyric_update": "http://0.0.0.0:8765/lyric_update",
      "status_update": "http://0.0.0.0:8765/status_update",
      "song_info": "http://0.0.0.0:8765/song_info",
      "lyric_update-SSE": "http://0.0.0.0:8765/lyric_update-SSE",
      "song_info-SSE": "http://0.0.0.0:8765/song_info-SSE"
    },
    "status": "playing",
    "now_time": "2026-03-19T12:34:56+08:00",
    "client_count": 2,
    "ws_connected": {
      "connected": true,
      "clients": [
        "192.168.1.100:54321",
        "192.168.1.200:54322"
      ]
    }
  }
}

version 说明：

编译时通过 -ldflags "-X main.Version=2.1.0" 注入

默认值为 0.0.0

示例: go build -ldflags "-X main.Version=2.1.0"

config_sources 说明：

显示配置来源的完整链路

按优先级顺序排列，后面的会覆盖前面的

可能的值："内置默认"、"config.yml"、"命令行参数"

示例：

["内置默认"] - 使用所有默认值

["config.yml"] - 所有值来自config.yml

["config.yml", "命令行参数"] - 从config.yml加载，部分被命令行参数覆盖

ws_connected 说明：

connected - 布尔值，表示是否有客户端连接

clients - 字符串数组，已连接的客户端IP地址列表（RemoteAddr格式）

当无客户端连接时，clients 为空数组

endpoints 说明：

返回所有可用接口的完整地址（带协议）

WebSocket接口使用 ws:// 或 wss:// 协议

HTTP接口使用 http:// 或 https:// 协议

SSE接口使用 http:// 或 https:// 协议

status 可能的值及含义：

"offline" - 服务离线（未连接到K歌进程）

"waiting_process" - K歌客户端未启动，等待用户运行 WeSing.exe

"loading" - 歌曲加载中

"playing" - 播放中

"paused" - 暂停中（play_time 停止推进时自动检测）

"waiting_song" - K歌窗口未打开/焦点丢失，等待用户打开或点击K歌窗口

"standby" - 待机状态，K歌客户端已退出

application/json

Body

示例

{
    "code": 0,
    "data": {
        "addr": "0.0.0.0:8765",
        "client_count": 1,
        "config": {
            "addr": "0.0.0.0:8765",
            "offset": 200,
            "poll": 30
        },
        "config_sources": [
            "config.yml"
        ],
        "endpoints": {
            "all_lyrics": "http://0.0.0.0:8765/all_lyrics",
            "health-check": "http://0.0.0.0:8765/health-check",
            "lyric_update": "http://0.0.0.0:8765/lyric_update",
            "lyric_update-SSE": "http://0.0.0.0:8765/lyric_update-SSE",
            "service-status": "http://0.0.0.0:8765/service-status",
            "song_info": "http://0.0.0.0:8765/song_info",
            "song_info-SSE": "http://0.0.0.0:8765/song_info-SSE",
            "status_update": "http://0.0.0.0:8765/status_update",
            "ws": "ws://0.0.0.0:8765/ws"
        },
        "now_time": "2026-03-20T00:54:50+08:00",
        "status": "playing",
        "version": "Metabox-Nexus-WesingCap-20260319-153453-e57d178",
        "ws_connected": {
            "clients": [
                "127.0.0.1:54834"
            ],
            "connected": true
        }
    },
    "msg": "success"
}

2. `/service-status` - 服务状态信息

请求参数

请求示例代码

返回响应

service-status

2. /service-status - 服务状态信息#

请求参数

请求示例代码

返回响应

2. `/service-status` - 服务状态信息