API планів

Список планів сервера, які ви можете використати для реалізації, з їх ресурсами і цінами. Передайте uid плану як plan_ uuid після створення або зміни розмірів сервера.

Кінцеві точки 2

Базовий шлях /api/v1/plans

ОТРИМАТИ /api/v1/plans/

Список усіх планів

Повертає кожен активний план, найдешевший з них. У списку не буде фільтрів, у поточному списку не буде вписуваності на одній сторінці.

Потрібний дозвіл: plans:list

Приклад запиту

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);

Приклад відповіді

{
  "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": ""
    }
  ]
}

Поля відповідей

Поле	Тип	Опис
`uuid`	string	Ідентифікатор планування. Скористайтеся ним як план_ uid або new_ plan_ uid.
`cpu`	integer	Кількість vCPUs
`ram`, `ram_unit`	integer, string	Сума пам' яті і одиниця виміру (МВ або ГБ)
`disk_space`	integer	Розмір диска у ГБ
`disk_space_total`	integer	Розмір диска в МБ
`transfer`, `transfer_unit`	integer, string	Щомісячне передавання даних з кишеньковими паперами (GB або ТБ)
`disk_space_unit`	string	Одиниця простору на диску (GB)
`includes_ipv4`	boolean	Чи включає план публічну IPv4-адресу. Плани без неї підтримують лише IPv6; IPv4-адресу можна додати за $2.00/місяць.
`monthly_price`, `price`	string	Щомісячна ціна в США як десятковий рядок. Ціна - це те ж саме значення.
`hourly_price`	string	Годова ціна у USD як десятковий рядок
`cpu_type_name`	string	Тип ЦП, наприклад, спільний. У разі відновлення даних планів без типу процесора, зокрема, плану GPU.
`is_active`	boolean	Завжди true у цьому списку, оскільки не буде повернуто неактивних планів
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Чи включає план віддане GPU, скільки і яка модель

Відповідь не повідомляє, чи містить у проект адресу IPv4. План 512 МБ - це лише IPv6; у інших поточних планах міститься IPv4. Порівняйте зі сторінкою Ціноутворення, перш ніж вибрати план сайта, який має бути доступним до сайта IPv4.

Коди стану відповіді

200	Успішно отримано список планів
403	Відсутній або некоректний ключ API або елемент не має потрібного дозволу

ОТРИМАТИ /api/v1/plans/{uuid}/

Отримати деталі плану

Повертає один активний план з вказаним вище полем. Неактивний або невідомий uid повертає 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": ""
}