API پلن‌ها

فهرست کردن برنامه‌های کارساز که می‌توانید با منابع و قیمت‌هایشان پیاده‌سازی کنید. هنگامی که یک کارساز را ایجاد یا تغییر اندازه می‌دهید، uuid برنامه را به عنوان plan_uuid منتقل کنید.

نقاط پایانی 2

مسیر پایه /api/v1/plans

دریافت کنید /api/v1/plans/

لیست همه طرح‌ها

هر طرح فعال را با ارزان‌ترین اول برمی‌گرداند. فهرست هیچ پالایه ندارد و در حال حاضر در یک صفحه جای می‌گیرد.

مجوز مورد نیاز: plans:list

درخواست نمونه

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

پاسخ نمونه

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

فیلدهای پاسخ

میدان	نوع	Description
`uuid`	string	شناسۀ طرح. از آن به عنوان plan_uuid یا new_plan_uuid استفاده کنید.
`cpu`	integer	تعداد vCPUها
`ram`, `ram_unit`	integer, string	مقدار حافظه و واحد آن) MB یا GB (
`disk_space`	integer	اندازه دیسک به گیگابایت
`disk_space_total`	integer	اندازه دیسک به مگابایت
`transfer`, `transfer_unit`	integer, string	مجوز انتقال داده ماهانه و واحد آن (GB یا TB)
`disk_space_unit`	string	واحد فضای_دیسک (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	قیمت ماهانه به دلار به صورت رشتهٔ اعشاری. قیمت همان مقدار است.
`hourly_price`	string	قیمت ساعتی به دلار آمریکا به عنوان رشته اعشاری
`cpu_type_name`	string	نوع CPU، برای مثال مشترک. برای نقشه‌هایی که نوع CPU ندارند، مانند نقشه GPU، حذف می‌شود.
`is_active`	boolean	همیشه در این فهرست درست ، چون نقشه‌های غیرفعال بازگردانده نمی‌شوند
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	آیا برنامه شامل GPU اختصاصی است، چند تا و چه مدلی

پاسخ نمی‌گوید که آیا یک برنامه شامل یک آدرس IPv4 است. برنامه ۵۱۲ مگابایتی فقط IPv6 است؛ برنامه‌های جاری دیگر شامل IPv4 هستند. قبل از انتخاب یک برنامه برای سایتی که باید از طریق IPv4 قابل دسترسی باشد، با صفحه قیمت مقایسه کنید.

کدهای وضعیت پاسخ

200	فهرست نقشه‌های با موفقیت بازیابی‌شده
403	نشان API مفقود یا نامعتبر، یا نشان اجازه مورد نیاز را ندارد

دریافت کنید /api/v1/plans/{uuid}/

جزئیات طرح را دریافت کنید

یک طرح فعال با حوزه‌های بالا را برمی‌گرداند. یک uuid غیرفعال یا ناشناخته 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": ""
}