Planer API

Lista serverplaner du kan distribuera, med deras resurser och priser. Skicka en plans uuid som plan_uuid när du skapar eller ändrar storlek på en server.

Slutpunkter 2

Basväg /api/v1/plans

FÅ /api/v1/plans/

Lista alla planer

Returnerar varje aktiv plan, billigaste först. Listan har inga filter och passar för närvarande på en sida.

Krav på tillstånd: plans:list

Exempelförfrågan

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

Exempelsvar

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

Svarsfält

Fält	Typ	Varuslag
`uuid`	string	Planidentifierare. Använd den som plan_uuid eller ny_plan_uuid.
`cpu`	integer	Antal vCPU-enheter
`ram`, `ram_unit`	integer, string	Minnesbelopp och dess enhet (MB eller GB)
`disk_space`	integer	Diskstorlek i GB
`disk_space_total`	integer	Diskstorlek i MB
`transfer`, `transfer_unit`	integer, string	Månatlig överföring av uppgifter och dess enhet (GB eller TB)
`disk_space_unit`	string	Enhet för disk_rymd (GB)
`includes_ipv4`	boolean	Om planen innehåller en offentlig IPv4-adress. Planer utan en är endast IPv6; en IPv4-adress kan läggas till för $2.00/månad.
`monthly_price`, `price`	string	Månadspris i USD som decimalsträng. Priset är samma värde.
`hourly_price`	string	Timpris i USD som decimalsträng
`cpu_type_name`	string	CPU-typ, till exempel Delad. Utelämnad för planer utan en CPU-typ, såsom GPU-planen.
`is_active`	boolean	Alltid sant i den här listan, eftersom inaktiva planer inte returneras
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Huruvida planen innehåller dedikerade GPU, hur många och vilken modell

Svaret säger inte om en plan innehåller en IPv4-adress. 512 MB-planen är endast IPv6-planen, övriga nuvarande planer inkluderar IPv4. Jämför med prissidan innan du väljer en plan för en webbplats som måste vara tillgänglig över IPv4.

Svarsstatuskoder

200	Framgångsrikt hämtad planlista
403	Saknas eller ogiltig API- token, eller token saknar den behörighet som krävs

FÅ /api/v1/plans/{uuid}/

Hämta planinformation

Returnerar en aktiv plan med fälten ovan. En inaktiv eller okänd uuid returnerar 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": ""
}