Rozhranie API pre plány

Zoznam serverových plánov, ktoré môžete nasadiť, s ich zdrojmi a cenami.Predajte uuid plánu ako plan_uuid pri vytváraní alebo zmene veľkosti servera.Predejte uuid plánu ako plan_uuid pri vytváraní alebo zmene veľkosti servera.

Koncové body 2

Základná cesta /api/v1/plans

ZÍSKAŤ /api/v1/plans/

Zoznam všetkých plánov

Zoznam nemá žiadne filtre a momentálne sa zmestí na jednu stránku, ale môžete ho upraviť podľa svojich potrieb.

Požadované povolenie: plans:list

Príklad žiadosti

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

Príklad odpovede

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

Polia odpovede

Pole	Typ	Opis
`uuid`	string	Identifikátor plánu. Použite ho ako plan_uuid alebo new_plan_uuid.
`cpu`	integer	Počet vCPU
`ram`, `ram_unit`	integer, string	Množstvo pamäte a jej jednotka (MB alebo GB)
`disk_space`	integer	Veľkosť disku v GB
`disk_space_total`	integer	Veľkosť disku v MB
`transfer`, `transfer_unit`	integer, string	Mesačný limit prenosu dát a jeho jednotka (GB alebo TB)
`disk_space_unit`	string	Jednotka priestoru na disku (GB)
`includes_ipv4`	boolean	Či plán obsahuje verejnú IPv4 adresu. Plány bez verejnej IPv4 adresy sú len IPv6. IPv4 adresu je možné pridať za $2.00/mesiac.
`monthly_price`, `price`	string	Mesačná cena v USD ako desatinný reťazec. cena je rovnaká hodnota.
`hourly_price`	string	Hodinová cena v USD ako desatinný reťazec
`cpu_type_name`	string	Typ procesora, napríklad Zdieľané.Vynechané pre plány bez typu procesora, ako je napríklad plán GPU.
`is_active`	boolean	V tomto zozname je hodnota vždy pravdivá, pretože neaktívne plány sa nevracajú
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Či plán zahŕňa vyhradené grafické procesory, koľko a ktorý model

Odpoveď nehovorí, či plán obsahuje IPv4 adresu.Plán 512 MB je len IPv6; ostatné aktuálne plány zahŕňajú IPv4. Pred výberom plánu pre stránku, ktorá musí byť dosiahnuteľná cez IPv4, porovnajte s cenou stránky.

Kódy stavu odpovede

200	Zoznam úspešne načítaných plánov
403	Chýbajúci alebo neplatný token API alebo token nemá požadované povolenie

ZÍSKAŤ /api/v1/plans/{uuid}/

Získajte podrobnosti o pláne

Vráti jeden aktívny plán s vyššie uvedenými poľami. Neaktívne alebo neznáme uuid vráti 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": ""
}