跳至文檔內容
開發者文檔API 參考查詢伺服器監控指標
GETBearer 權杖

查詢伺服器監控指標

/api/v1/servers/:id/metrics

查詢已儲存的伺服器監控資料。latest 是最新回報,samples 是歷史資料點,兩者結構不同。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/metrics?period=24hr" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

僅提供範例,此頁不會發送 API 請求。

回應示例
JSON
{
  "period": "24hr",
  "serverStatus": "running",
  "metrics": {
    "online": false,
    "reportingMode": 1,
    "reportInterval": 60,
    "lastReportedAt": null,
    "lastSampledAt": null,
    "bootChangedAt": null,
    "shutdownAt": null
  },
  "latest": null,
  "samples": []
}

參數

id路徑 · 必填

string

資源 ID:24 個十六進位字元。請使用對應列表端點回傳的平台 ID,而非供應商的執行個體 ID。

period查詢字串 · 選填

"1hr" | "24hr" | "7d"

預設為 24hr。

回應

HTTP 狀態 200

讀取儲存的主機監控指標、最新回報與歷史取樣。

periodstring ('1hr' | '24hr' | '7d')

請求的歷史時間範圍。

serverStatusstring

標準化後的儲存伺服器狀態。

metricsobject

監控存活狀態的中繼資料。

metrics.onlineboolean

近期回報是否顯示監控程式在線上。

metrics.reportingModenumber

目前設定的回報模式,預設為一。

metrics.reportIntervalnumber

預期的回報間隔,單位為秒。

metrics.lastReportedAtstring (ISO 8601) | null

最後收到回報的時間戳記。

metrics.lastSampledAtstring (ISO 8601) | null

最後取樣時間戳記。

metrics.bootChangedAtstring (ISO 8601) | null

最後偵測到的開機識別變更。

metrics.shutdownAtstring (ISO 8601) | null

最後回報的關機時間。

latestobject | null

最近儲存的監控指標或關機回報;尚無回報時為 null。其欄位與歷史取樣不同。

latest.version1

回報格式版本。

latest.kind"metrics" | "shutdown"

回報類型。

latest.bootIdstring (UUID)

回報所屬的開機識別碼。

latest.intervalnumber

取樣間隔,5–300 秒。

latest.uptimenumber

開機持續時間,單位為秒。

latest.sampledAtnumber (optional)

用戶端取樣時間戳記,為 Unix epoch 起算的毫秒數。

latest.cpunumber | null

CPU 使用率,0–100%;無法取得時為 null。

latest.memoryUsednumber

已使用的記憶體位元組數。

latest.memoryTotalnumber

記憶體總位元組數。

latest.swapUsednumber

已使用的交換空間位元組數。

latest.swapTotalnumber

交換空間總位元組數。

latest.diskReadnumber | null

磁碟讀取速率,單位為位元組/秒。

latest.diskWritenumber | null

磁碟寫入速率,單位為位元組/秒。

latest.netInnumber | null

網路接收速率,單位為位元組/秒。

latest.netOutnumber | null

網路傳送速率,單位為位元組/秒。

latest.disksobject[]

最多 32 個已掛載磁碟,包含 mount(字串)、total(位元組)及 used(位元組)。

samplesarray

最多 600 個依時間排序的歷史資料點。數值為各時間區間的平均值;low 與 high 保留各指標的最小值與最大值。

samples[].atstring (ISO 8601)

歷史取樣時間戳記。

samples[].cpunumber | null

CPU 使用率百分比;無法取得時為 null。

samples[].memoryUsednumber | null

容量,單位為位元組;無法取得時為 null。

samples[].memoryTotalnumber | null

容量,單位為位元組;無法取得時為 null。

samples[].swapUsednumber | null

容量,單位為位元組;無法取得時為 null。

samples[].swapTotalnumber | null

容量,單位為位元組;無法取得時為 null。

samples[].diskReadnumber | null

傳輸速率,單位為位元組/秒;無法取得時為 null。

samples[].diskWritenumber | null

傳輸速率,單位為位元組/秒;無法取得時為 null。

samples[].netInnumber | null

傳輸速率,單位為位元組/秒;無法取得時為 null。

samples[].netOutnumber | null

傳輸速率,單位為位元組/秒;無法取得時為 null。

samples[].uptimenumber | null

開機持續時間,單位為秒;無法取得時為 null。

samples[].disksarray

已掛載磁碟:{mount: string, used: number, total: number}。容量單位為位元組。

samples[].lowobject

各指標的最小值,以相同的十個數值指標名稱作為鍵。

samples[].highobject

各指標的最大值,以相同的十個數值指標名稱作為鍵。