VPS.org API

REST API ҳужжатлаштириш

Rejalar APIsi

Сервернинг ресурслари ва нархлари билан ишга туширилиши мумкин бўлган сервер режаларини рўйхатга олинг. Серверни яратиш ёки ўлчамини ўзгартиришда режанинг uuid'ини plan_uuid'га ўтказинг.

Tugash nuqtalari 2
Asosiy yo'l /api/v1/plans
OLING /api/v1/plans/

Barcha rejalar ro'yxati

Барча фаол режаларни, энг арзонини биринчи бўлиб қайтаради. Рўйхатда филтрлар йўқ ва ҳозирда бир саҳифага мос келади.

Ҳужжат талаб этилади: plans:list

Namunaviy so'rov

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

Javob namunasi

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

Javob maydonlari

Асосий Turi Тасвирлаш
uuid string План идентификатори. Уни plan_uuid ёки new_plan_uuid сифатида ишлатинг.
cpu integer vCPUлар сони
ram, ram_unit integer, string Хотира миқдори ва унинг бирлиги (MB ёки GB)
disk_space integer Диск ҳажми (GB)
disk_space_total integer Диск ҳажми MB да
transfer, transfer_unit integer, string Ойлик маълумотларни кўчириш квоталари ва унинг бирлиги (GB ёки TB)
disk_space_unit string Диск_жами бирлиги (GB)
includes_ipv4 boolean Планда жамоат IPv4 манзили бўлиши керакми ёки йўқми. Буни кўрсатмайдиган планлар фақат IPv6'га эга; IPv4 манзили $2.00/ой учун қўшилади.
monthly_price, price string Ойлик нархи долларда ўнлик string сифатида. нархи ҳам шу қийматда.
hourly_price string Соат нархини $$да ўнлик string сифатида кўрсатинг
cpu_type_name string CPU тури, масалан, Умумий. CPU тури бўлмаган, масалан, GPU тури бўлмаган режалар учун бу кўрсаткич йўқ қилинади.
is_active boolean Бу рўйхатда доимо ҳақ, чунки фаол бўлмаган режалар қайтарилмайди
is_gpu, gpu_count, gpu_model boolean, integer, string Планга ажратилган GPUлар киритилганми, қанча ва қайси модел
Жавобда план IPv4 манзилини қамраб олган-қолмаганини айтилмайди. 512 MB план фақат IPv6; бошқа ҳозирги планлар IPv4'ни қамраб олади. IPv4 орқали етиб бориш мумкин бўлган сайт учун план танлашдан олдин нархлар саҳифасини солиштиринг.

Javob holati kodlari

200 Муваффақиятли олиб олинган режалар рўйхати
403 API токен йўқ ёки нодуруст, ёки токенда талаб қилинган рухсат йўқ
OLING /api/v1/plans/{uuid}/

Reja tafsilotlarini oling

Юқоридаги майдонлар билан бир фаол режани қайтаради. Фаол бўлмаган ёки номаълум 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": ""
}