VPS.org API

REST API sənədləşdirilməsi

Planlar API-si

İcra edə biləcəyiniz server planlarını resursları və qiymətləri ilə siyahıya al. Verici yaratdığınızda və ya yenidən ölçüsünü dəyişdirdiyiniz zaman planın uuid'ini plan_uuid olaraq keçin.

Son Nöqtələr 2
Əsas Yol /api/v1/plans
AL /api/v1/plans/

Bütün Planları Siyahıya Alın

Ən ucuzu əvvəlcədən olan bütün aktiv planları geri qaytarır. Siyahıda filtr yoxdur və hazırda bir səhifəyə uyğundur.

İcazə tələb olunur: plans:list

Nümunə Sorğ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);

Nümunə Cavab

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

Cavab Sahələri

Sahə Növü İzahat
uuid string Plan identifikatoru. plan_uuid ya da new_plan_uuid kimi istifadə et.
cpu integer Vəziyyət
ram, ram_unit integer, string Qeyd miqdarı və onun vahidi (MB və ya GB)
disk_space integer Disk böyüklüyü (GB)
disk_space_total integer Disk böyüklüyü (MB)
transfer, transfer_unit integer, string Aylıq məlumat ötürülməsi icazəsi və onun vahidi (GB və ya TB)
disk_space_unit string Disk boşluğunun vahidi (GB)
includes_ipv4 boolean Planın ictimai IPv4 ünvanını ehtiva edib etmədiyini göstər. Bu olmadan planlar yalnız IPv6-dır; IPv4 ünvanı ayda $2.00 üçün əlavə edilə bilər.
monthly_price, price string Aylıq qiymət dollarda onluq string olaraq. price is the same value.
hourly_price string Saat qiyməti onluq string olaraq USD
cpu_type_name string CPU növü, məsələn Paylaşılmış. CPU növü olmayan planlar üçün, məsələn GPU planı üçün buraxılır.
is_active boolean Bu siyahıda hər zaman doğrudur, çünki qeyri-fəal planlar geri qaytarılmır
is_gpu, gpu_count, gpu_model boolean, integer, string Planın xüsusi GPU-ları ehtiva edib etmədiyini, neçəsini və hansı modelini
Cavab planın IPv4 ünvanını ehtiva edib etmədiyini bildirir. 512 MB plan yalnız IPv6'dır; digər hazırkı planlar IPv4'ü ehtiva edir. IPv4 üzərindən çata biləcək bir sayt üçün plan seçmədən əvvəl qiymət səhifəsi ilə müqayisə edin.

Cavab Status Kodları

200 Müvəffəqiyyətlə alınan planlar siyahısı
403 API tokeni yoxdu ya da səhvdir, ya da tokenin lazımi icazəsi yoxdur
AL /api/v1/plans/{uuid}/

Plan Təfərrüatlarını Əldə Edin

Üstdəki sahələr ilə bir aktiv planı geri qaytarır. Fayl aktiv deyilsə və ya namə'lum uuid varsa 404 geri qaytarılır.

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