VPS.org API 文件

入门

VPS.org API 允许您以编程方式管理 VPS 主机基础设施的各个方面，包括服务器、域名、DNS 记录、备份和快照。

验证

所有 API 请求都需要使用 Bearer 令牌进行身份验证。您可以在帐户设置中生成 API 令牌。 admin.vps.org/account/developers/.

cURL

Python

JavaScript

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

每个牌子都携带自己的权限, 如服务器: list 或 dns: * 。需要该牌子没有的许可的请求会被拒绝, 403个和指定缺失许可的指定_ permission 字段。权限参考

速率限制

验证后的请求以每个账户每小时1,000个请求为限,未经认证的请求以每个IP地址每小时100个为限,超过这一限额的请求收到429个,使用Retry-after 头列出等待的秒数。

铺

列表端点返回对象, 下、前和结果, 每页25项。页面中将有一个对象, 下、前和结果, 25项。页面页面可以在页面之间移动, 或者跟随下一个 URL, 直至它无效。服务器列表还接受页面_ 尺寸, 最多100 。

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

错误处理

API 使用标准的 HTTP 状态码来指示成功或失败：

状态码	说明
`200`	成功 - 请求已成功完成
`201`	资源已成功创建
`400`	错误请求 - 无效参数或格式错误的请求
`202`, `204`	接受并排队(202个)或删除,无答复机构(204个)
`402`	所需付款:档案、未付发票或拒绝的事先授权卡片上没有付款方法
`403`	禁止: Token丢失、无效或过期, 或缺少所需的许可。失败的验证还返回 403 个, 不是 401个。
`404`	未找到 - 资源不存在
`409`	冲突:例如,已经进行中的调整规模, 能力不足, 部署已经启动
`429`	请求过多 - 超出速率限制
`500`	内部服务器错误 - 我们这边出了点问题
`503`	服务不可用: 暂时问题。重试, 发送后为重试敬重。