VPS.org API

REST API dokumentacija

API za načrte

Naštejte načrte strežnika, ki jih lahko uporabite z njihovimi viri in cenami. Podajte načrt uuid kot plan_ uuid, ko ustvarite ali spremenite velikost strežnika.

Končne točke 2
Osnovna pot /api/v1/plans
PRIDOBITE /api/v1/plans/

Seznam vseh načrtov

Vrne vsak aktivni načrt, najcenejši najprej. Seznam nima filtrov in trenutno meri na eno stran.

Zahtevano dovoljenje: plans:list

Primer zahteve

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

Primer odgovora

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

Polja za odgovor

Polje Vrsta Opis
uuid string Uporabi ga kot načrt_uuid ali novo_plan_uid.
cpu integer Število vCPU
ram, ram_unit integer, string Količina spomina in enota (MB ali GB)
disk_space integer Velikost diska v GB
disk_space_total integer Velikost diska v MB
transfer, transfer_unit integer, string Mejni dodatek za prenos podatkov in njegovo enoto (GB ali TB)
disk_space_unit string Enota diska_ prostora (GB)
includes_ipv4 boolean Ali načrt vključuje javni naslov IPv4. Načrti brez njega so samo IPv6; IPv4 naslov je mogoče dodati za 2,00 $/mesec.
monthly_price, price string Mesečna cena v USD kot decimalna niz. cena je enaka vrednost.
hourly_price string Urna cena v USD kot decimalna nizka
cpu_type_name string Tip CPU, na primer Shared. Oddano za načrte brez tipa CPU, kot je GPU načrt.
is_active boolean Vedno velja na tem seznamu, ker neaktivni načrti niso vračeni
is_gpu, gpu_count, gpu_model boolean, integer, string Ali načrt vključuje namenske GPU, koliko in kateri model
Odziv ne pove, ali načrt vsebuje naslov IPv4. Načrt 512 MB je samo IPv6; drugi trenutni načrti vključujejo IPv4. Primerjajte s strani za določanje cen pred izbiro načrta za spletno stran, ki mora biti dosegljiva v okviru IPv4.

Kode stanja odgovora

200 Seznam načrtov, ki so bili uspešno pridobljeni
403 Manjkajoči ali neveljavni API žeton, ali token manjka zahtevano dovoljenje
PRIDOBITE /api/v1/plans/{uuid}/

Pridobi podrobnosti o načrtu

Vrne en aktivni načrt z zgornjimi polji. Neaktiven ali neznan uuid vrne 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": ""
}