API планов

Перечислите планы сервера, которые вы можете использовать, с их ресурсами и ценами. Передайте план в качестве плана, когда вы создадите или переоформите сервер.

Конечные точки 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	Идентификатор плана. Используйте его как план_uuid или новый план_uuid.
`cpu`	integer	Число vCPU
`ram`, `ram_unit`	integer, string	Сумма памяти и ее единица (МБ или GB)
`disk_space`	integer	Размер диска в GB
`disk_space_total`	integer	Размер диска в БМ
`transfer`, `transfer_unit`	integer, string	Ежемесячное лимит на передачу данных и его единица (ББ или ТБ)
`disk_space_unit`	string	Единица дискового_пространства (GB)
`includes_ipv4`	boolean	План включает публичный адрес IPv4. Планы без одного только IPv6; адрес IPv4 может быть добавлен за 2,00 долл. в месяц.
`monthly_price`, `price`	string	Месячная цена в долл. США как десятичная строка. Цена - это та же стоимость.
`hourly_price`	string	Часовая цена в долл. США как десятичная строка
`cpu_type_name`	string	Тип CPU, например Shared. Отсутствует у планов без типа CPU, например у GPU-плана.
`is_active`	boolean	Всегда верно в этом списке, потому что неактивные планы не возвращаются
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Включает ли план специальные ГПС, сколько и какую модель

В ответе не указывается, включает ли план адрес IPv4. План 512 MB является только IPv6, а другие текущие планы включают IPv4. Сравните со страницей цен перед выбором плана для сайта, который должен быть доступен для IPv4.

Коды состояния ответа

200	Список успешно найденных планов
403	Недопущенный или недействительный токен API или же знак не имеет требуемого разрешения

ПОЛУЧАТЬ /api/v1/plans/{uuid}/

Получить подробную информацию о тарифном плане

Возвращает один активный план с указанными выше полями. Неактивный или неизвестный uuid возвращает 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": ""
}