VPS.org API

REST API dokumentacija

Planų API

Išvardykite serverio planus, kuriuos galite įdiegti su jų ištekliais ir kainomis. Kurdami ar keisdami serverį, perleiskite plano uuid kaip plan_uid.

Galutiniai taškai 2
Bazinis kelias /api/v1/plans
GAUTI /api/v1/plans/

Išvardinti visus planus

Grįžta į kiekvieną aktyvų planą, pigiausias pirmas. Sąraše nėra filtrų ir šiuo metu tinka viename puslapyje.

Reikalingas leidimas: plans:list

Prašymo pavyzdys

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

Atsakymo pavyzdys

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

Atsakymo laukai

Laukas Tipas Aprašymas
uuid string Plano identifikatorius. Naudokite jį kaip plan_uid arba kaip naują_plan_uuid.
cpu integer VCPU skaičius
ram, ram_unit integer, string Atminties dydis ir jo vienetas (MB arba GB)
disk_space integer Disko dydis GB
disk_space_total integer Disko dydis MB
transfer, transfer_unit integer, string Mėnesio duomenų perdavimo pašalpa ir jos vienetas (GB arba TB)
disk_space_unit string Disko_erdvės vienetas (GB)
includes_ipv4 boolean Ar planas turi viešą IPv4 adresą. Planai be vieno yra tik IPv6; IPv4 adresas gali būti pridėtas už 2.00 $/mėnesį.
monthly_price, price string Mėnesinė kaina USD kaip dešimtainės eilutės. kaina yra ta pati vertė.
hourly_price string Valandos kaina JAV doleriais kaip dešimtainės eilutės
cpu_type_name string CPU tipas, pavyzdžiui Bendro naudojimo. Priklauso planui be CPU tipo, pvz., GPU planui.
is_active boolean Visada teisinga šiame sąraše, nes neaktyvūs planai negrąžinami
is_gpu, gpu_count, gpu_model boolean, integer, string Ar planas apima tam skirtas GPU, kiek, ir koks modelis
Atsakyme nesakoma, ar planas apima IPv4 adresą. 512 MB planas yra tik IPv6; kituose dabartiniuose planuose yra IPv4. Palyginti su kainodaros puslapiu prieš pasirenkant planą, skirtą svetainei, kuri turi būti pasiekiama IPv4.

Atsakymo būsenos kodai

200 Sėkmingai išgautų planų sąrašas
403 Trūksta arba netinkamas API žetonas, arba žetonas neturi reikiamo leidimo
GAUTI /api/v1/plans/{uuid}/

Gauti plano informaciją

Grįžta vienas aktyvus planas su laukeliais aukščiau. Neaktyvus arba nežinomas uuid grįžta 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": ""
}