VPS.org API

REST API Documentation

Plaanide API

Loetle serveri plaanid saab kasutusele, nende ressursse ja hindu. Pass plaan uudid nagu plan_uid kui sa luua või suuruse serveri.

Lõpp-punktid 2
Baasrada /api/v1/plans
SAA /api/v1/plans/

Loetle kõik plaanid

Tagastab iga aktiivse plaani, mis on kõige odavam. Nimekirjas pole filtreid ja see mahub praegu ühele lehele.

Nõutav luba: plans:list

Näidistaotlus

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äidisvastus

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

Vastuseväljad

Väli Tüüp Description
uuid string Plaani identifikaator. Kasuta seda plaani_uid või new_plan_uid.
cpu integer VCPUde arv
ram, ram_unit integer, string Mälu hulk ja selle ühik (MB või GB)
disk_space integer Ketta suurus GB-s
disk_space_total integer Ketta suurus MB-s
transfer, transfer_unit integer, string Igakuine andmeedastustoetus ja selle ühik (GB või TB)
disk_space_unit string ketta_ruumi (GB) ühik
includes_ipv4 boolean Kas plaan sisaldab avalikku IPv4 aadressi. Ilma üheta plaanid on ainult IPv6; IPv4 aadressi saab lisada $2,00/kuus.
monthly_price, price string Kuu hind USD kümnendikring. hind on sama väärtus.
hourly_price string Tunnihind USA dollarites kümnendjadana
cpu_type_name string CPU tüüp, näiteks Shared. Kasutati CPU tüübita plaane, näiteks GPU plaani.
is_active boolean Alati tõene selles nimekirjas, sest mitteaktiivseid plaane ei tagastata
is_gpu, gpu_count, gpu_model boolean, integer, string Kas plaan sisaldab spetsiaalseid GPU-sid, kui palju ja millist mudelit
Vastus ei ütle, kas plaan sisaldab IPv4 aadressi. 512 MB plaan on ainult IPv6; teised praegused plaanid sisaldavad IPv4. Võrreldes hinna lehega enne IPv4 kaudu kättesaadava saidi plaani valimist.

Vastuse olekukoodid

200 Edukalt hangitud plaanide nimekiri
403 Puuduv või vigane API märgis või märgil puudub nõutav luba
SAA /api/v1/plans/{uuid}/

Hankige paketi üksikasjad

Tagastab ühe aktiivse plaani väljadega ülal. Mitteaktiivse või tundmatu uudi tagastab 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": ""
}