VPS.org API

Documentare API REST

API-ul Planurilor

Înscrie planurile serverului pe care le puteți implementa, cu resursele și prețurile lor. Pass un program uuid ca plan_uuid atunci când creați sau redimensionați un server.

Puncte finale 2
Calea de bază /api/v1/plans
OBŢINE /api/v1/plans/

Listați toate planurile

Returnează fiecare plan activ, cel mai ieftin primul. Lista nu are filtre și se potrivește în prezent pe o singură pagină.

Permisul necesar: plans:list

Exemplu de solicitare

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

Exemplu de răspuns

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

Câmpuri de răspuns

Câmp Tip Descriere
uuid string Identificator plan. Folosește-l ca plan_uuid sau nou_uuid plan_uid.
cpu integer Numărul de VCPU
ram, ram_unit integer, string Cantitatea de memorie și unitatea sa (MB sau GB)
disk_space integer Dimensiune disc în GB
disk_space_total integer Dimensiune disc în MB
transfer, transfer_unit integer, string Alocația lunară de transfer de date și unitatea sa (GB sau TB)
disk_space_unit string Unitate de discu_ spațiu (GB)
includes_ipv4 boolean Dacă planul include o adresă IPv4 publică. Planurile fără unu sunt doar IPv6; o adresă IPv4 poate fi adăugată pentru $2.00/luna.
monthly_price, price string Prețul lunar în USD ca un cord decimal. Prețul este aceeași valoare.
hourly_price string Prețul orar în USD ca un cod decimal
cpu_type_name string Tipul CPU, de exemplu, Shared. Omitet pentru planuri fără un tip CPU, cum ar fi planul GPU.
is_active boolean Întotdeauna adevărat în această listă, deoarece planurile inactive nu sunt returnate
is_gpu, gpu_count, gpu_model boolean, integer, string Dacă planul include GPU dedicate, câte, și care model
Răspunsul nu spune dacă un plan include o adresă IPv4. Planul 512 MB este doar IPv6; celelalte planuri curente includ IPv4. Comparați cu pagina de prețuri înainte de a alege un plan pentru un site care trebuie să fie accesibil peste IPv4.

Coduri de stare a răspunsului

200 Lista de planuri recuperate cu succes
403 Token API lipsă sau nu este valid, sau tokenul nu este permisul necesar
OBŢINE /api/v1/plans/{uuid}/

Obțineți detalii despre plan

Returnează un plan activ cu câmpurile de mai sus. Un uuid inactiv sau necunoscut returnează 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": ""
}