伺服器狀態
取得及時的伺服器狀態,並回傳 JSON 資料。
methods: GET, POST
bash
https://sr-api.sfirew.com/server/<伺服器位址>:<連接阜>
你可以這樣
如果伺服器連接阜預設是 25565,你不需要填寫,所以可以這樣寫 https://sr-api.sfirew.com/server/mc.hypixel.net
Query Parameters
Name | Type | Description |
---|---|---|
timeout | string | 你可以自訂查詢耗時的限制時間,以毫秒為單位。 例如:5000 為 5 秒。 |
protocol | number | 可以選擇特定伺服器版本做查詢。 例如:765,為麥塊版本 1.20.3。 |
bedrock | boolean | 是否使用基岩版查詢模式。 |
Query Path Parameter
Name | Type | Description |
---|---|---|
伺服器位址 | string | 例如:mc.hypixel.net |
連接阜 | number | 伺服器連接阜 範圍:0 ~ 65535 預設:25565 |
回應結果範例
伺服器是否在線上,Status Code 回應都會是 200
JSON
{
"ip": "catnoob.net", // 伺服器位址
"port": 25565, // 伺服器連接阜
"online": true, // 如果伺服器線上會是 true 不是的話則是 false
"isp": false, // ISP 資訊,目前暫停取得
"source_address": "hidden", // 真實的主機位置,暫時不顯示。
"dns_records": false, // DNS 紀錄,暫時不顯示。
"query_place": "Taiwan", // 查詢狀態的主機位置
"query_host_id": "taipei-1", // 查詢狀態的主機 ID
"bedrock": false, // 如果伺服器是基岩版則會是 true
"icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABAC......", // 伺服器圖標
"motd": {
// 原始的 MOTD 資料
"raw": {
"extra": [
{
"extra": [
{ "color": "#FFA500", "text": "【" },
{ "color": "#FFAB05", "text": "貓" },
{ "color": "#FFB00B", "text": "咪" },
{ "color": "#FFB610", "text": "村" },
{ "color": "#FFBC15", "text": "伺" },
{ "color": "#FFC11B", "text": "服" },
{ "color": "#FFC720", "text": "器" },
{ "color": "#FFCC25", "text": " " },
{ "color": "#FFD22B", "text": "-" },
{ "color": "#FFD830", "text": " " },
{ "color": "#FFDD35", "text": "1" },
{ "color": "#FFE33A", "text": "." },
{ "color": "#FFE940", "text": "2" },
{ "color": "#FFEE45", "text": "0" },
{ "color": "#FFF44A", "text": "." },
{ "color": "#FFF950", "text": "1" },
{ "color": "yellow", "text": "】" }
],
"text": " "
},
// ...
],
"text": ""
},
// 轉換成 HTML 的 MOTD,可以應用在網站上
"html": " \u003Cspan style=\"color:#FFA500;\"\u003E【\u003C/span\u003E\u003Cspan style=\"color:#FFAB05;\"\u003E貓\u003C/span\u003E\u003Cspan style=\"color:#FFB00B;\"\u003E咪\u003C/span\u003E\u003Cspan style=\"color:#FFB610;\"\u003E村\u003C/span\u003E\u003Cspan style=\"color:#FFBC15;\"\u003E伺\u003C/span\u003E\u003Cspan style=\"color:#FFC11B;\"\u003E服\u003C/span\u003E\u003Cspan style=\"color:#FFC720;\"\u003E器\u003C/span\u003E\u003Cspan style=\"color:#FFCC25;\"\u003E \u003C/span\u003E\u003Cspan style=\"color:#FFD22B;\"\u003E-\u003C/span\u003E\u003Cspan style=\"color:#FFD830;\"\u003E \u003C/span\u003E\u003Cspan style=\"color:#FFDD35;\"\u003E1\u003C/span\u003E\u003Cspan style=\"color:#FFE33A;\"\u003E.\u003C/span\u003E\u003Cspan style=\"color:#FFE940;\"\u003E2\u003C/span\u003E\u003Cspan style=\"color:#FFEE45;\"\u003E0\u003C/span\u003E\u003Cspan style=\"color:#FFF44A;\"\u003E.\u003C/span\u003E\u003Cspan style=\"color:#FFF950;\"\u003E1\u003C/span\u003E\u003Cspan style=\"color:#FFFF55;\"\u003E】\u003C/span\u003E\u003Cbr/\u003E \u003Cspan style=\"color:#FFFFFF;font-weight: bold;\"\u003E【\u003Cspan style=\"color:#FFA500;\"\u003E公告\u003Cspan style=\"color:#FFFFFF;\"\u003E】\u003Cspan style=\"color:#00FFFF;\"\u003E爆\u003C/span\u003E\u003Cspan style=\"color:#0EFFFF;\"\u003E肝\u003C/span\u003E\u003Cspan style=\"color:#1CFFFF;\"\u003E附\u003C/span\u003E\u003Cspan style=\"color:#2BFFFF;\"\u003E魔\u003C/span\u003E\u003Cspan style=\"color:#39FFFF;\"\u003E書\u003C/span\u003E\u003Cspan style=\"color:#47FFFF;\"\u003E限\u003C/span\u003E\u003Cspan style=\"color:#55FFFF;\"\u003E時\u003C/span\u003E\u003Cspan style=\"color:#63FFFF;\"\u003E兌\u003C/span\u003E\u003Cspan style=\"color:#71FFFF;\"\u003E換\u003C/span\u003E\u003Cspan style=\"color:#80FFFF;\"\u003E中\u003C/span\u003E\u003Cspan style=\"color:#8EFFFF;\"\u003E~\u003C/span\u003E\u003Cspan style=\"color:#9CFFFF;\"\u003E \u003C/span\u003E\u003Cspan style=\"color:#AAFFFF;\"\u003E每\u003C/span\u003E\u003Cspan style=\"color:#B8FFFF;\"\u003E月\u003C/span\u003E\u003Cspan style=\"color:#C6FFFF;\"\u003E1\u003C/span\u003E\u003Cspan style=\"color:#D5FFFF;\"\u003E6\u003C/span\u003E\u003Cspan style=\"color:#E3FFFF;\"\u003E號\u003C/span\u003E\u003Cspan style=\"color:#F1FFFF;\"\u003E更\u003C/span\u003E\u003Cspan style=\"color:#FFFFFF;\"\u003E新\u003C/span\u003E\u003C/span\u003E\u003C/span\u003E\u003C/span\u003E"
},
// info 資訊
"info": {
// 原始資料
"raw": "",
// 轉換成 HTML 的 info
"html": ""
},
// 玩家資訊
"players": {
"max": 200, // 最大線上人數
"online": 116, // 目前玩家人數
"sample": [] // 玩家列表,有些伺服器會隱藏起來
},
// 版本資訊
"version": {
"name": "1.20.4", // 版本名稱
"protocol": 765, // 伺服器版本的協議號碼
"raw": "BungeeCord 1.8.x-1.20.x" // 版本或是伺服器核心名稱
},
// 模組資訊,有些伺服器不會顯示。
"modinfo": {
"type": "FML", // 模組類型名稱,此範例為 Forge Mod Loader (FML)
"modList": [] // 模組列表
},
"ping": 5 // 伺服器響應時間 - 使用毫秒(ms)為單位
}
使用範例
bash
bash
curl -X 'GET' \
'https://sr-api.sfirew.com/server/mc.hypixel.net'
JavaScript
javascript
async function queryServerStatus() {
const response = await fetch("https://sr-api.sfirew.com/server/mc.hypixel.net");
const status = await response.json();
console.log(status);
}
queryServerStatus();