VPS.org API

Dokumentace REST API

API plánů

Seznamte plány serveru, které můžete nasadit, s jejich zdroji a cenami. Pošlete plán uuid jako plán_uuid, když vytvoříte nebo změníte velikost serveru.

Koncové body 2
Základní cesta /api/v1/plans
ZÍSKAT /api/v1/plans/

Zobrazit všechny tarify

Vrací každý aktivní plán, nejlevnější první. Seznam nemá žádné filtry a v současné době se vejde na jednu stránku.

Požadované povolení: plans:list

Příklad žádosti

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

Příklad odpovědi

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

Pole odpovědí

Pole Typ Popis zboží
uuid string Plan identifier. Use it as plan_uuid or new_plan_uuid.
cpu integer Počet vCPU
ram, ram_unit integer, string Množství paměti a její jednotka (MB nebo GB)
disk_space integer Velikost disku v GB
disk_space_total integer Velikost disku v MB
transfer, transfer_unit integer, string Měsíční příspěvek na přenos dat a její jednotka (GB nebo TB)
disk_space_unit string Jednotka disk_space (GB)
includes_ipv4 boolean Zda plán obsahuje veřejnou IPv4 adresu. Plány bez jedné jsou pouze IPv6; IPv4 adresu lze přidat za 2.00 dolarů měsíčně.
monthly_price, price string Měsíční cena v USD jako desítkový řetězec. cena je stejná hodnota.
hourly_price string Hodinová cena v USD jako desítkový řetězec
cpu_type_name string Typ CPU, například Sdílený. Omitted pro plány bez typu CPU, jako je plán GPU.
is_active boolean Vždy platí v tomto seznamu, protože neaktivní plány nejsou vráceny
is_gpu, gpu_count, gpu_model boolean, integer, string Zda plán zahrnuje specializované GPU, kolik, a který model
Odpověď neříká, zda plán obsahuje IPv4 adresu. Plán 512 MB je pouze IPv6; ostatní aktuální plány zahrnují IPv4. Porovnejte s cenovou stránkou před výběrem plánu pro stránky, které musí být dostupné přes IPv4.

Kódy stavu odpovědi

200 Úspěšně získaný seznam plánů
403 Chybí nebo neplatná API žeton, nebo žeton postrádá požadované povolení
ZÍSKAT /api/v1/plans/{uuid}/

Zobrazit podrobnosti o tarifu

Vrací jeden aktivní plán s polemi nahoře. Neaktivní nebo neznámý uuid vrací 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": ""
}