VPS.org API

REST API құжаттамасы

Жоспарлар API

Орындауға болатын сервер жоспарлары, олардың ресурстары мен бағалары көрсетіледі. Серверді құрғанда немесе өлшемін өзгерткенде жоспардың uuid- і 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 Жоспардың идентификаторы. plan_ uuid немесе new_ plan_ uuid деп қолданыңыз.
cpu integer vCPU саны
ram, ram_unit integer, string Жад мөлшері мен бірлігі (Мб не Гб)
disk_space integer Диск өлшемі (ГБ)
disk_space_total integer Диск өлшемі (МБ)
transfer, transfer_unit integer, string Айлық дерек тасымалдау мөлшері мен бірлігі (Гб не Тб)
disk_space_unit string Диск_орнының бірлігі (ГБ)
includes_ipv4 boolean Бағдарламаның ашық IPv4 адресін қамтитын- қамтымайтыны. Бұл параметрсіз бағдарламалар тек IPv6-ға ғана қол жеткізе алады. IPv4 адресін $2.00/ ай үшін қосуға болады.
monthly_price, price string Айлық бағасы долларда, ондық таңбамен. price деген де осымен бірдей.
hourly_price string Сағаттық бағасы (доллар) ондық таңба ретінде
cpu_type_name string Процессордың түрі, мысалы, Ортақ. Процессордың түрі жоқ жоспарлар үшін, мысалы, Графикалық процессор жоспары үшін, бұл параметр келтірілмейді.
is_active boolean Бұл тізімдегі әрқашан true, өйткені белсенді емес жоспарлар қайтарылмайды
is_gpu, gpu_count, gpu_model boolean, integer, string Жоспардың арнайы графикалық процессорларды қамти ма, қанша және қай үлгіде
Жауапта жоспардың IPv4 адресі бар ма, жоқ па, дегені көрсетілмейді. 512 Мб жоспары тек IPv6- ға арналған, ал басқа жоспарлар IPv4- ке де қосылған. IPv4 арқылы байланысу керек сайт үшін жоспарды таңдамас бұрын бағалау парағын қараңыз.

Жауап күйінің кодтары

200 Жоспар тізімі сәтті алынған
403 API токені жоқ немесе жарамсыз, немесе токеннің қажетті рұқсаты жоқ
АЛУ /api/v1/plans/{uuid}/

Жоспар мәліметтерін алыңыз

Returns one active plan with the fields above. An inactive or unknown uuid returns 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": ""
}