VPS.org API

เอกสาร REST API

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

ช่องตอบกลับ

ช่อง พิมพ์ คำอธิบาย
uuid string ตัวระบุแผน ใช้เป็น plan_ uuid หรือ new_ plan_ uuid
cpu integer จำนวนของ vCPUs
ram, ram_unit integer, string ขนาดของหน่วยความจำและหน่วยของมัน (MB หรือ GB)
disk_space integer ขนาดแผ่นดิสก์ หน่วยเป็น GB
disk_space_total integer ขนาดแผ่นดิสก์ หน่วยเป็น MB
transfer, transfer_unit integer, string หน่วยของการโอนข้อมูลและจำนวนการโอนข้อมูลในแต่ละเดือน (GB หรือ TB)
disk_space_unit string หน่วยของพื้นที่ดิสก์ (GB)
includes_ipv4 boolean ว่าแผนจะรวมที่อยู่ IPv4 สาธารณะหรือไม่ แผนที่ไม่มีที่อยู่ IPv4 จะใช้ IPv6 เท่านั้น สามารถเพิ่มที่อยู่ IPv4 ได้ด้วยค่าใช้จ่าย $2.00/เดือน
monthly_price, price string ค่าราคาในเดือนในรูปแบบสัญลักษณ์หลักสิบ ค่าราคาจะเท่ากัน
hourly_price string ราคาต่อชั่วโมงในดอลลาร์สหรัฐ เป็นตัวเลขทศนิยม
cpu_type_name string ประเภทของซีพียู เช่น ใช้ร่วมกัน ไม่ต้องระบุสำหรับแผนที่ไม่มีประเภทของซีพียู เช่น แผน GPU
is_active boolean ใช้เป็นค่าจริงตลอดเวลาในรายการนี้ เพราะแผนการที่ไม่ทำงานจะไม่ถูกส่งกลับมา
is_gpu, gpu_count, gpu_model boolean, integer, string ว่าแผนจะรวม GPU ไว้ในแผนการใช้งานหรือไม่, มีเท่าไหร่ และรุ่นใด
การตอบกลับไม่ได้บอกว่าแผนการจัดส่งมีที่อยู่ IPv4 หรือไม่ แผนการจัดส่ง 512 MB ใช้ IPv6 เท่านั้น; แผนการจัดส่งปัจจุบันอื่น ๆ มี IPv4 ด้วย โปรดเปรียบเทียบกับหน้าราคาก่อนเลือกแผนการจัดส่งสำหรับเว็บไซต์ที่ต้องสามารถเข้าถึงได้ผ่าน IPv4

รหัสสถานะการตอบกลับ

200 ดึงรายการแผนการได้สำเร็จ
403 ไม่มีหรือไม่สามารถใช้ API token ได้ หรือ token นั้น ไม่มีสิทธิ์ที่จำเป็น
รับ /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": ""
}