VPS.org API

Tài liệu API REST

API Kế hoạch

Danh sách các kế hoạch máy chủ có thể triển khai, với các nguồn và giá của chúng. Chuyển uuid của kế hoạch thành plan_ uuid khi tạo hoặc thay đổi kích thước máy chủ.

Điểm cuối 2
Đường cơ sở /api/v1/plans
LẤY /api/v1/plans/

Liệt kê tất cả các gói

Trả lại tất cả các kế hoạch đang hoạt động, rẻ nhất trước. Danh sách không có bộ lọc và hiện có thể chứa trên một trang.

Cần quyền: plans:list

Ví dụ về yêu cầu

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/plans/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/plans/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for plan in response.json()["results"]:
    print(plan["uuid"], plan["cpu"], plan["ram"], plan["ram_unit"], plan["monthly_price"])
const response = await fetch('https://admin.vps.org/api/v1/plans/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);
$ch = curl_init('https://admin.vps.org/api/v1/plans/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$plans = json_decode(curl_exec($ch), true);
curl_close($ch);

Ví dụ về câu trả lời

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
      "cpu": 1,
      "ram": 512,
      "ram_unit": "MB",
      "disk_space": 10,
      "disk_space_total": 10240,
      "transfer": 500,
      "transfer_unit": "GB",
      "includes_ipv4": false,
      "price": "2.50",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.004",
      "monthly_price": "2.50",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    },
    {
      "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
      "cpu": 1,
      "ram": 2,
      "ram_unit": "GB",
      "disk_space": 25,
      "disk_space_total": 25600,
      "transfer": 1,
      "transfer_unit": "TB",
      "includes_ipv4": true,
      "price": "5.00",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.007",
      "monthly_price": "5.00",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    }
  ]
}

Các trường phản hồi

Địa điểm Kiểu Mô tả
uuid string Định danh kế hoạch. Dùng nó như plan_ uuid hoặc new_ plan_ uuid.
cpu integer Số vCPU
ram, ram_unit integer, string Kích thước bộ nhớ và đơn vị của nó (MB hay GB)
disk_space integer Cỡ đĩa (GB)
disk_space_total integer Cỡ đĩa (MB)
transfer, transfer_unit integer, string Tặng dữ liệu chuyển đổi hàng tháng và đơn vị của nó (GB hoặc TB)
disk_space_unit string Đơn vị của disk_ space (GB)
includes_ipv4 boolean Cho biết gói có bao gồm địa chỉ IPv4 công khai hay không. Các gói không có địa chỉ này chỉ hỗ trợ IPv6; có thể thêm địa chỉ IPv4 với giá $2.00/tháng.
monthly_price, price string Giá hàng tháng trong USD như một chuỗi thập phân. giá là cùng một giá trị.
hourly_price string Giá giờ bằng USD như một chuỗi thập phân
cpu_type_name string Kiểu CPU, ví dụ: Chia sẻ. Bỏ qua cho các kế hoạch không có kiểu CPU, như kế hoạch GPU.
is_active boolean Luôn luôn đúng trong danh sách này, vì kế hoạch không hoạt động không được trả lại
is_gpu, gpu_count, gpu_model boolean, integer, string Có phải kế hoạch bao gồm GPU chuyên dụng, bao nhiêu và mẫu nào
Phản hồi không nói liệu kế hoạch có bao gồm địa chỉ IPv4 hay không. Kế hoạch 512 MB chỉ bao gồm IPv6; các kế hoạch hiện tại khác bao gồm IPv4. So sánh với trang giá trước khi chọn kế hoạch cho một trang web cần phải có thể truy cập qua IPv4.

Mã trạng thái phản hồi

200 Đã lấy lại danh sách kế hoạch thành công
403 Thiếu hoặc không hợp lệ token API, hoặc token không có quyền cần thiết
LẤY /api/v1/plans/{uuid}/

Xem chi tiết gói cước

Trả lại một kế hoạch hoạt động với các trường trên. Một uuid không hoạt động hay không biết sẽ trả lại 404.

curl -X GET "https://admin.vps.org/api/v1/plans/ed0ac717-c26c-4d9b-a801-b170c4979028/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
  "cpu": 1,
  "ram": 512,
  "ram_unit": "MB",
  "disk_space": 10,
  "disk_space_total": 10240,
  "transfer": 500,
  "transfer_unit": "GB",
  "includes_ipv4": false,
  "price": "2.50",
  "cpu_type_name": "Shared",
  "is_active": true,
  "hourly_price": "0.004",
  "monthly_price": "2.50",
  "is_gpu": false,
  "gpu_count": 0,
  "gpu_model": ""
}