服务状态信息

返回完整的服务状态信息，包括版本、配置、播放器状态、已连接客户端等。

version 说明：

编译时通过 -ldflags "-X main.Version=3.0.0-beta.1" 注入

默认值为 0.0.0

tag_name 使用完整 semver；若 release 标题以 -force 结尾，则客户端允许强制同步到更低版本

config_sources 说明：

实际生效的配置来源列表。存在 config.yml 时其值为 config.yml（内置默认 已被它取代、不再出现在列表中）；命令行覆盖了任何键时追加 命令行参数。为未设键兜底的内置默认不体现在此列表

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

config_overwritten 说明：

列出被更高优先级来源覆盖的配置键名

仅在有覆盖时出现非空数组

player_support 说明：

系统编译时注册的所有播放器标识名列表

player_running 说明：

当前正在运行（非 offline / standby / waiting_process）的播放器列表

player_status 说明：

所有支持的播放器及其当前状态（按注册顺序），值为 status 字符串

可能的状态值："offline"（服务端兜底：从未上报过状态）/ "waiting_process" / "waiting_song" / "playing" / "paused" / "standby" / "error"（仅 kugou 故障终态）。"loading" 为保留值，当前版本不会出现

注意 "error" 不在 player_running 的排除集内，故障中的 kugou 仍会出现在 player_running 里

ws_connected 说明：

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

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

endpoints 说明：

返回所有可用接口的完整地址（含 Per-player 端点）

WebSocket 使用 ws://，HTTP/SSE 使用 http://

返回响应

🟢200

application/json

200 成功

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "success",
    "player": "internal",
    "data": {
        "version": "3.0.0-beta.1",
        "addr": "0.0.0.0:8765",
        "now_time": "2026-03-19T12:34:56+08:00",
        "config_sources": [
            "config.yml",
            "命令行参数"
        ],
        "config": {
            "addr": "0.0.0.0:8765",
            "offset": 200,
            "poll": 30,
            "prior-player": [
                "wesing"
            ],
            "prior-player-expire": 15,
            "cloudmusicv3-effect-strategy": "fadeout",
            "wesing-offset": 200,
            "wesing-poll": 30,
            "cloudmusicv3-offset": 500,
            "cloudmusicv3-poll": 30,
            "qqmusic-offset": 200,
            "qqmusic-poll": 50,
            "kugou-offset": 430,
            "kugou-poll": 30,
            "sodamusic-offset": 200,
            "sodamusic-poll": 30
        },
        "config_overwritten": [
            "offset",
            "wesing-poll"
        ],
        "player_support": [
            "wesing",
            "cloudmusicv3",
            "qqmusic",
            "kugou",
            "sodamusic"
        ],
        "player_running": [
            "wesing"
        ],
        "player_status": {
            "wesing": "playing",
            "cloudmusicv3": "waiting_process",
            "qqmusic": "waiting_process",
            "kugou": "waiting_process",
            "sodamusic": "waiting_process"
        },
        "endpoints": {
            "health-check": "http://0.0.0.0:8765/health-check",
            "service-status": "http://0.0.0.0:8765/service-status",
            "ws": "ws://0.0.0.0:8765/ws",
            "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",
            "wesing": {
                "ws": "ws://0.0.0.0:8765/wesing/ws",
                "all_lyrics": "http://0.0.0.0:8765/wesing/all_lyrics",
                "lyric_update": "http://0.0.0.0:8765/wesing/lyric_update",
                "status_update": "http://0.0.0.0:8765/wesing/status_update",
                "song_info": "http://0.0.0.0:8765/wesing/song_info",
                "lyric_update-SSE": "http://0.0.0.0:8765/wesing/lyric_update-SSE",
                "song_info-SSE": "http://0.0.0.0:8765/wesing/song_info-SSE"
            },
            "cloudmusicv3": {
                "ws": "ws://0.0.0.0:8765/cloudmusicv3/ws",
                "all_lyrics": "http://0.0.0.0:8765/cloudmusicv3/all_lyrics",
                "lyric_update": "http://0.0.0.0:8765/cloudmusicv3/lyric_update",
                "status_update": "http://0.0.0.0:8765/cloudmusicv3/status_update",
                "song_info": "http://0.0.0.0:8765/cloudmusicv3/song_info",
                "lyric_update-SSE": "http://0.0.0.0:8765/cloudmusicv3/lyric_update-SSE",
                "song_info-SSE": "http://0.0.0.0:8765/cloudmusicv3/song_info-SSE",
                "effect-ws": "ws://0.0.0.0:8765/cloudmusicv3/effect-ws",
                "effect-ingest": "ws://0.0.0.0:8765/cloudmusicv3/effect-ingest"
            },
            "qqmusic": {
                "ws": "ws://0.0.0.0:8765/qqmusic/ws",
                "all_lyrics": "http://0.0.0.0:8765/qqmusic/all_lyrics",
                "lyric_update": "http://0.0.0.0:8765/qqmusic/lyric_update",
                "status_update": "http://0.0.0.0:8765/qqmusic/status_update",
                "song_info": "http://0.0.0.0:8765/qqmusic/song_info",
                "lyric_update-SSE": "http://0.0.0.0:8765/qqmusic/lyric_update-SSE",
                "song_info-SSE": "http://0.0.0.0:8765/qqmusic/song_info-SSE"
            },
            "kugou": {
                "ws": "ws://0.0.0.0:8765/kugou/ws",
                "all_lyrics": "http://0.0.0.0:8765/kugou/all_lyrics",
                "lyric_update": "http://0.0.0.0:8765/kugou/lyric_update",
                "status_update": "http://0.0.0.0:8765/kugou/status_update",
                "song_info": "http://0.0.0.0:8765/kugou/song_info",
                "lyric_update-SSE": "http://0.0.0.0:8765/kugou/lyric_update-SSE",
                "song_info-SSE": "http://0.0.0.0:8765/kugou/song_info-SSE"
            },
            "sodamusic": {
                "ws": "ws://0.0.0.0:8765/sodamusic/ws",
                "all_lyrics": "http://0.0.0.0:8765/sodamusic/all_lyrics",
                "lyric_update": "http://0.0.0.0:8765/sodamusic/lyric_update",
                "status_update": "http://0.0.0.0:8765/sodamusic/status_update",
                "song_info": "http://0.0.0.0:8765/sodamusic/song_info",
                "lyric_update-SSE": "http://0.0.0.0:8765/sodamusic/lyric_update-SSE",
                "song_info-SSE": "http://0.0.0.0:8765/sodamusic/song_info-SSE"
            }
        },
        "client_count": 2,
        "ws_connected": {
            "connected": true,
            "clients": [
                "192.168.1.100:54321",
                "192.168.1.200:54322"
            ]
        }
    }
}

请求参数

请求示例代码

返回响应