VPS API 可以自動化甚麼?
經常建立及刪除伺服器,或一次管理多部伺服器時,VPS API 最能發揮作用。以下整理了四種常見自動化。
在部署流程中建立伺服器
在 GitLab CI 等部署流程中以 POST /servers 請求建立測試伺服器,測試完成後以 DELETE 請求刪除。只在需要的一刻才有伺服器,成本清晰整齊。
伺服器狀態查看與電源管理
以 GET /servers 讀取你的伺服器清單、狀態、IPv4 及 IPv6 位址及下一個收費日,需要時以 start、stop、reboot 請求管理電源。亦可連接監察工具,編寫重新啟動停頓伺服器的腳本。
在自己的服務內銷售及營運伺服器
在自建管理畫面或機械人中呼叫 API 建立伺服器並顯示結果。以銷售清單 GET /catalog 照樣讀取可選大小、地區、作業系統及選項,顯示在畫面上。
收費日管理與續期
透過 paid_until 值查詢每部伺服器的下次結帳日,並對需要預付更長週期的伺服器立即發送續費請求。透過代碼追蹤發票與結帳日,確保重要伺服器穩定運行。
控制台與 VPS API,何時用哪個?
控制台與 API 使用相同帳戶管理相同伺服器。手動管理少量伺服器時控制台較方便,重複性作業或管理多部伺服器時 API 效率更高。
控制台
在畫面點按管理的方式
適合對象
- 首次建立伺服器時
- 親自管理一兩部伺服器時
- 重新安裝作業系統及登記 SSH 金鑰
- 再次查看 root 密碼時
雲端伺服器 API 如何連接?
只需三步驟:1) 完成首次付款並確認後,在 API 金鑰頁面建立金鑰;2) 使用 Bearer 模式將金鑰放入每個請求的 Authorization 標頭;3) 向 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 建立的伺服器與選項價格與控制台建立完全相同。
API 免費使用
簽發 API 金鑰與發送請求均不收費。任何完成首次付款的會員均可立即建立並使用金鑰。
每分鐘 300 次請求
一個金鑰每分鐘最多 300 次請求,對查看伺服器清單、管理電源等日常自動化綽綽有餘。
與控制台相同價格
透過 API 建立的伺服器價格與價目表一致,選項費用相同,並在每個結帳日自動續費。
數字看 HELPER VPS
在一個帳戶中選擇 40 個地區、12 個操作系統和 10 個一鍵應用程式,並立即支付。以下數字基於目前的銷售清單。
40
數據中心地區
12
作業系統
10
一鍵應用程式
免費
此產品起價(每月)
與 VPS API 一同使用的自動化工具
只要能發出 HTTP 請求的工具都可連接 VPS API。由一行 curl 到 Python、Node.js 腳本以至部署流程,都以相同方式使用。
- Terraform
- Python
- Node.js
- GitLab CI
- Docker
選擇 HELPER VPS API 的原因
簡單的 JSON REST
以熟悉的 HTTP 方法及 JSON 發出請求及接收回應,毋須額外程式庫,用 curl 亦可即時測試。
API 金鑰(Bearer)驗證
在 Authorization 標頭放入一個金鑰,任何語言及工具都以相同方法驗證。
每分鐘 300 次請求
一個金鑰每分鐘最多 300 次請求,從容處理多部伺服器的狀態查看及電源管理。
以程式碼讀取銷售清單
以 GET /catalog 讀取大小、地區、作業系統及選項價格,直接用於你的畫面及腳本。
由建立到刪除
伺服器建立、清單、開機、關機、重新啟動、續期及刪除,全部以 API 處理。
一併選擇選項
建立伺服器時,可在一個請求中一併放入自動備份、額外硬碟、DDoS 防護及 SSH 金鑰。
原因清晰的錯誤代碼
錯誤原因以代碼分類(如帳戶餘額不足、伺服器數量上限、狀態不符等),便於程式處理。
與控制台相同帳戶
透過 API 建立的伺服器會如實顯示在控制台,支付與續費方式相同。
所有會員免費
完成首次付款後,即可免費建立 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 時值得閱讀的指引
- API 文件基本位址、驗證標頭、各路徑請求範例及回應格式,以及完整錯誤代碼清單。
- 建立及登記 SSH 金鑰建立並登記 SSH 金鑰,讓你可以金鑰即時登入以 API 建立的伺服器。
- 一覽收費在一頁比較可經 API 選擇的伺服器大小及選項月費。
VPS API 對所有會員免費,完成首次付款後即可建立 API 金鑰。透過 API 建立的伺服器與選項價格與價目表一致,並在每個結帳日以相同金額自動續費。
請求限制:每個 API 金鑰每分鐘 300 次 | 每個帳戶 10 部伺服器 | 支付失敗時:伺服器暫停,3 天後刪除 | 已刪除伺服器的剩餘時間不予退款。退款將退回帳戶餘額。
