VPS.org API

Dokumentasi API REST

API Pelan

Senarai rancangan pelayan yang anda boleh laksanakan, dengan sumber dan harga mereka. Serahkan uuid rancangan sebagai plan_uuid bila anda cipta atau saiz semula pelayan.

Titik akhir 2
Laluan Asas /api/v1/plans
DAPATKAN /api/v1/plans/

Senaraikan Semua Pelan

Kembalikan setiap rancangan aktif, paling murah pertama. Senarai tidak mempunyai penapis dan kini sesuai pada satu halaman.

Keizinan diperlukan: plans:list

Contoh Permintaan

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

Contoh Respons

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

Medan Respons

Medan Jenis Huraian
uuid string Pengenalpasti rancangan. Gunakannya sebagai plan_uuid atau new_plan_uuid.
cpu integer Bilangan vCPUs
ram, ram_unit integer, string Jumlah memori dan unitnya (MB atau GB)
disk_space integer Saiz cakera dalam GB
disk_space_total integer Saiz cakera dalam MB
transfer, transfer_unit integer, string Keizinan pemindahan data bulanan dan unitnya (GB atau TB)
disk_space_unit string Unit ruang cakera (GB)
includes_ipv4 boolean Samada rancangan termasuk alamat IPv4 awam. rancangan tanpa satu hanya IPv6; alamat IPv4 boleh ditambah untuk $2.00/bulan.
monthly_price, price string Harga bulanan dalam USD sebagai rentetan desimal. harga adalah nilai yang sama.
hourly_price string Harga setiap jam dalam USD sebagai rentetan desimal
cpu_type_name string Jenis CPU, contohnya Berkongsi. Dibuang untuk rancangan tanpa jenis CPU, seperti rancangan GPU.
is_active boolean Sentiasa benar dalam senarai ini, kerana rancangan tidak aktif tidak dikembalikan
is_gpu, gpu_count, gpu_model boolean, integer, string Samada rancangan termasuk GPUs terdedikasi, berapa banyak, dan model mana
Jawapan tidak menyatakan sama ada rancangan termasuk alamat IPv4. rancangan 512 MB hanya IPv6; rancangan semasa lain termasuk IPv4. Bandingkan dengan halaman harga sebelum memilih rancangan untuk tapak yang mesti boleh dicapai melalui IPv4.

Kod Status Respons

200 Senarai rancangan berjaya diperoleh
403 Token API hilang atau tidak sah, atau token tidak mempunyai keizinan yang diperlukan
DAPATKAN /api/v1/plans/{uuid}/

Dapatkan Butiran Pelan

Kembalikan satu rancangan aktif dengan medan di atas. Uuid tidak aktif atau tidak diketahui mengembalikan 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": ""
}