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 Якияти фазои диск (ГБ)
includes_ipv4 boolean Оё нақша суроғаи IPv4-и оммавиро дар бар мегирад. Нақшаҳои бе суроға танҳо IPv6 мебошанд; суроғаи IPv4 барои $2.00/моҳа илова карда мешавад.
monthly_price, price string Моҳонаи нархи дар USD ҳамчун даҳӣ сатр. нархи аст, ки ҳамон арзиш.
hourly_price string Нархи соатӣ дар доллари ИМА ҳамчун сатри даҳӣ
cpu_type_name string Намуди CPU, масалан, Муштарак. Барои нақшаҳои бе намуди CPU, монанди нақшаи GPU, рад карда мешавад.
is_active boolean Ҳамеша дар ин рӯйхат ҳақ аст, чунки нақшаҳои ғайрифаъол баргардонида намешаванд
is_gpu, gpu_count, gpu_model boolean, integer, string Оё нақша GPU-ҳои махсусро дар бар мегирад, чандто ва кадом модел
Ҷавоб намегӯяд, ки оё нақша суроғаи IPv4- ро дар бар мегирад. Нақшаи 512 МБ танҳо IPv6 мебошад; нақшаҳои дигари ҷорӣ IPv4- ро дар бар мегиранд. Пеш аз интихоби нақша барои пойгоҳе, ки бояд аз IPv4 дастрас бошад, бо саҳифаи нархҳо муқоиса кунед.

Рамзҳои ҳолати посух

200 Рӯйхати нақшаҳои бомуваффақият гирифташуда
403 API-и нодуруст ё гумшуда ё иҷозатномаи лозимӣ барои 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": ""
}