HELPER VPS

VPS API,用 JSON REST 自動化雲端伺服器

從建立到刪除,用程式碼管理伺服器的雲端伺服器 API

  • JSON REST API
  • API 金鑰(Bearer)認證
  • 每分鐘300次請求

VPS API 是一種程式化的方式,透過 HTTP 請求執行您在控制面板中進行的操作,例如建立、啟動、停止和刪除伺服器。HELPER VPS 雲端伺服器 API 對所有會員免費;首次付款後,建立一個 API 金鑰並立即連接。

  • REST API

    所有會員

    免費

    按月計費

    • JSON REST
    • API 金鑰(Bearer)
    • 每分鐘300次
    • 免費

想直接檢視請求示例和回應格式 API 文件

VPS API 可以自動化哪些工作?

需要頻繁建立和刪除伺服器,或一次管理多台伺服器時,VPS API 最能發揮作用。下面整理了四種常用的自動化。

控制面板和 VPS API,什麼時候用哪個?

控制面板和 API 使用相同的帳戶和伺服器。對於手動管理一兩台伺服器,控制面板更方便;對於重複操作或管理多台伺服器,API 更快。

控制面板

在頁面上點選管理的方式

適合人群

  • 第一次建立伺服器時
  • 自己管理一兩台伺服器時
  • 重灌作業系統和新增 SSH 金鑰
  • 再次檢視 root 密碼時

VPS API

用程式碼傳送請求管理的方式

適合人群

  • 頻繁建立和刪除伺服器的測試環境
  • 部署流水線和腳本自動化
  • 一次讀取多台伺服器狀態時
  • 與自建管理頁面或機器人對接時

如何接入雲端伺服器 API?

接入分三步。首先,完成首次付款,確認後在 API 金鑰頁面建立一個金鑰。接著,使用 Bearer 方案將金鑰放入每個請求的 Authorization 標頭中。最後,向基礎地址 https://helpervps.com/api/v1 後加上所需路徑發送請求,結果以 JSON 返回。

建議先呼叫 GET /catalog。會一次返回目前可選的伺服器類型和規格、地區代碼、作業系統和一鍵應用程式碼,以及自動備份、額外磁碟、DDoS 防護的價格。把這裡得到的 plan、location、image 代碼直接填入建立伺服器請求即可。

要建立伺服器,請將 plan、location、image 和 label 值以 JSON 格式發送到 POST /servers。您還可以包含您新增的 SSH 金鑰 ID 以及 backups、extra_disk_gb 和 ddos_protection 選項。您需要預先支付所選的週期,回應中包含伺服器 ID、狀態和 root 密碼,請立即將其保存在安全的地方。

VPS API 能執行哪些操作?

VPS API 覆蓋伺服器的整個生命週期。用 GET /catalog 讀取在售列表,用 POST /servers 建立伺服器,用 GET /servers 讀取伺服器列表,用 GET /servers/{id} 讀取單台伺服器資訊。回應中包含伺服器名稱、狀態、IPv4 和 IPv6 地址、月費、所選選項和下一個付款日。

電源透過 POST /servers/{id}/start、stop、reboot 請求開機、關機和重啟。POST /servers/{id}/renew 無需等待付款日,立即支付一個月費用續費;DELETE /servers/{id} 刪除伺服器。請求與伺服器目前狀態不符時,會返回 wrong_state 代碼,方便腳本決定下一步操作。

錯誤會以狀態碼加含 error 值的 JSON 返回。金鑰錯誤為 unauthorized,餘額不足為 not_enough_balance,帳戶伺服器數量達到上限為 limit,請求過多為 rate_limited,原因按代碼區分,便於程式按情況處理。完整列表和回應示例見 API 文件。

VPS API 收費嗎?

VPS API 對所有會員免費。使用 API 建立的伺服器和選項的價格與在控制面板中建立的伺服器相同。

數字看 HELPER VPS

在一個帳戶中選擇 40 個地區、12 個作業系統和 10 個一鍵應用,並立即支付。以下數字基於目前在售的內容。

可與 VPS API 搭配使用的自動化工具

只要能傳送 HTTP 請求,任何工具都能接入 VPS API。從一行 curl 到 Python、Node.js 腳本以及部署流水線,用法都一樣。

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

選擇 HELPER VPS API 的理由

VPS API 常見問題

關於 VPS API 接入、認證和請求限制的解答

VPS API 免費嗎?

是的,VPS API 對所有會員免費。發放 API 金鑰和發出請求免費,使用 API 建立的伺服器和選項的價格與在控制面板中建立的伺服器相同。任何完成首次付款的會員都可以立即在 API 金鑰頁面建立金鑰。

在哪裡建立 API 金鑰?

完成首次付款後,API 金鑰頁面 (/api-key) 將開放,您可以在那裡建立金鑰。使用 Bearer 方案將金鑰放入每個請求的 Authorization 標頭中。金鑰解鎖您的整個帳戶,因此請不要將其提交到程式碼儲存庫;將其保存在環境變數或金鑰管理工具中。

API 可以執行哪些操作?

可以讀取在售列表(GET /catalog)、讀取伺服器列表和單台資訊(GET /servers、GET /servers/{id})、建立伺服器(POST /servers)、開機、關機和重啟(start、stop、reboot)、續費一個月(renew)、刪除(DELETE /servers/{id})。請求示例和回應格式見 API 文件。

請求限制是多少?

一個金鑰每分鐘最多可請求300次。超出限制會返回 429 狀態碼和 rate_limited 錯誤,在腳本中處理為稍等後重新傳送即可。查詢伺服器列表和電源管理等日常自動化在此限制內執行綽綽有餘。不按請求次數收費。

透過 API 建立伺服器,費用如何扣除?

當 POST /servers 請求成功時,您所選的付款週期將被處理,伺服器將被建立。建立失敗的伺服器的付款將退回到您的帳戶餘額。

如何透過 API 取得 root 密碼?

建立伺服器請求的回應中會包含一次 root_password 值。收到回應後請立即儲存到安全的地方。在控制面板中也可在7天內再次檢視,同時傳送 SSH 金鑰編號的話,無需密碼即可用金鑰直接連線。可以用回應中的 ipv4 值立即開始 SSH 連線,便於與部署腳本銜接。

可以透過 API 放入 SSH 金鑰嗎?

可以。在建立伺服器請求的 ssh_key_id 中填入已新增的 SSH 金鑰編號,新伺服器就會放入該金鑰。金鑰只需在控制面板的 SSH 金鑰頁面新增一次,指紋以與 ssh-keygen 相同的方式顯示,一眼就能確認是哪個金鑰。金鑰編號定好後可以重複使用。

可以用哪些語言或工具?

只要能傳送 HTTP 請求,任何語言和工具都可以。可以用 curl 直接測試,在 Python 的 requests、Node.js 的 fetch、GitLab CI 的腳本步驟、Terraform 的 HTTP 請求功能中,用相同的地址和請求標頭呼叫。回應都是 JSON,結果易於讀取。

出錯時如何得知?

錯誤會以非 2xx 的狀態碼加含 error 值的 JSON 返回。金鑰錯誤為 unauthorized,缺少值為 bad_request,餘額不足為 not_enough_balance,請求與伺服器狀態不符為 wrong_state,原因清晰區分,程式可按情況處理。

透過 API 建立的伺服器也會顯示在控制面板中嗎?

會。API 和控制面板操作的是同一個帳戶和同一批伺服器。透過 API 建立的伺服器會直接顯示在控制面板列表中,可在控制面板中重灌作業系統或檢視密碼。每個帳戶10台伺服器的上限也同時適用於兩種方式。手動操作和程式碼操作混用,狀態和付款日也始終一致。

VPS API 指南

首次接入 API 時值得一讀的指南文章

VPS API 對所有會員免費,您可以在完成首次付款後建立 API 金鑰。使用 API 建立的伺服器和選項的價格與價格表相同,並在每個付款日以相同金額自動續費。

請求限制:每個 API 金鑰每分鐘 300 次 | 每個帳戶 10 台伺服器 | 如果付款失敗:伺服器暫停,3 天後刪除 | 已刪除伺服器的剩餘時間不予退款。退款將退回到您的帳戶餘額。