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 代码直接填入创建服务器请求即可。
创建服务器时,向POST /servers发送包含plan、location、image和label值的JSON数据。可附加已添加的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天后删除 | 已删除服务器的剩余时间不予退款。退款将退回账户余额。
