Suunnitelmat-API

Luettele palvelimen suunnitelmat, jotka voit ottaa käyttöön, niiden resurssit ja hinnat. Syötä suunnitelman uuid suunnitelmaksi, kun luot tai muutat palvelimen kokoa.

Päätepisteet 2

Perusreitti /api/v1/plans

SAADA /api/v1/plans/

Listaa kaikki sopimukset

Palauttaa jokaisen aktiivisen suunnitelman, halvin ensin. Listalla ei ole suodattimia ja se sopii tällä hetkellä yhdelle sivulle.

Vaadittu lupa: plans:list

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä	Tyyppi	Tavaran kuvaus
`uuid`	string	Suunnitelmatunniste. Käytä sitä suunnitelmana tai uutena.
`cpu`	integer	VCPU-yksiköiden määrä
`ram`, `ram_unit`	integer, string	Muistimäärä ja sen yksikkö (MB tai GB)
`disk_space`	integer	Levyn koko GB:ssä
`disk_space_total`	integer	Levyn koko MB-muodossa
`transfer`, `transfer_unit`	integer, string	Kuukausittainen tiedonsiirtokorvaus ja sen yksikkö (GB tai TB)
`disk_space_unit`	string	Levy_avaruusyksikkö (GB)
`includes_ipv4`	boolean	Whether the plan includes a public IPv4 address. Plans without one are IPv6 only; an IPv4 address can be added for $2.00/month.
`monthly_price`, `price`	string	Kuukausihinta Yhdysvaltain dollareina desimaalina. Hinta on sama arvo.
`hourly_price`	string	Tuntihinta Yhdysvaltain dollareina desimaalina
`cpu_type_name`	string	Esimerkiksi Jaettu. Tilaus on annettu ilman CPU-tyyppiä, kuten GPU-suunnitelmaa.
`is_active`	boolean	Aina totta tässä luettelossa, koska ei-aktiivisia suunnitelmia ei palauteta
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Onko suunnitelmassa mukana omatoimisia GPU-laitteita, kuinka monta ja mikä malli?

Vastauksessa ei kerrota, sisältääkö suunnitelma IPv4-osoitteen. 512 MB:n suunnitelma on vain IPv6, ja muut nykyiset suunnitelmat sisältävät IPv4:n. Vertaa sitä hinnoittelusivuun ennen kuin valitset suunnitelman sivustolle, joka on tavoitettavissa IPv4:n ohi.

Vastauksen tilakoodit

200	Onnistunut suunnitelmaluettelo
403	Puuttuva tai virheellinen API-tunnus tai postimerkki puuttuu vaaditusta luvasta

SAADA /api/v1/plans/{uuid}/

Hanki sopimuksen tiedot

Palauttaa yhden aktiivisen suunnitelman yllä olevilla kentillä. Aktiivinen tai tuntematon uuid palauttaa 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": ""
}