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 Холбоо барих
ram, ram_unit integer, string Мэтрийн хэмжээ ба түүний нэгж (МБ эсвэл ГБ)
disk_space integer Дискний хэмжээ, ГБ
disk_space_total integer Дискний хэмжээ, МБ
transfer, transfer_unit integer, string Сар бүрийн дата дамжуулах хэмжээ ба түүний нэгж (GB эсвэл TB)
disk_space_unit string Дискний зай (GB)
includes_ipv4 boolean Энэ төлөвлөгөөнд нийтийн IPv4 хаяг багтах эсэх. Хэрэв ийм хаяг байхгүй бол зөвхөн IPv6-г ашиглах боломжтой. IPv4 хаягийг сарын 2.00 доллараар нэмж болно.
monthly_price, price string Сарын үнэ доллараар, аравтын тоогоор. Price нь ижил утгатай.
hourly_price string Тоо томшгүй тооны мөрөөр цаг тутам $- ээр үнэлнэ
cpu_type_name string CPU- ийн төрөл, жишээ нь Хуваалцах. CPU- ийн төрөлгүй төлөвлөгөө, жишээ нь ГП- ийн төлөвлөгөөнд энэ нь хэрэггүй.
is_active boolean Энэ жагсаалтад үргэлж үнэн байх, учир нь идэвхгүй төлөвлөгөөнүүд буцаагддаггүй
is_gpu, gpu_count, gpu_model boolean, integer, string Энэ төлөвлөгөөнд зориулсан график процессорууд багтах эсэх, хэдэн, ямар загвартай байх
Энэ хариу нь төлөвлөгөөнд IPv4 хаяг орсон эсэхийг зааж өгөхгүй. 512 MB төлөвлөгөө нь зөвхөн 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": ""
}