VPS.org API

REST API баримт бичиг

Үйлдлийн Системийн API

Суулгаж болох үйлдлийн систем болон тэдгээрийн хувилбаруудыг жагсаана. Сервер үүсгэх үед хувилбарын uuid-ийг operating_system_version_uuid-д дамжуулна.

Төгсгөлийн цэгүүд 2
Суурийн зам /api/v1/operating-systems
АВАХ /api/v1/operating-systems/

Операциын системүүдийн жагсаалт

Бүх үйлдлийн системийг идэвхтэй хувилбаруудтай нь эргүүлэн өгнө. Энэ жагсаалтад шүүлтүүр байхгүй.

Зөвшөөрөл шаардагдана: operating-systems:list

Жишээ хүсэлт

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/operating-systems/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/operating-systems/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for os_entry in response.json()["results"]:
    for version in os_entry["versions"]:
        print(os_entry["name"], version["name"], version["uuid"])
const response = await fetch('https://admin.vps.org/api/v1/operating-systems/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
for (const os of data.results) {
  for (const version of os.versions) {
    console.log(os.name, version.name, version.uuid);
  }
}

Жишээ хариулт

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Ubuntu",
      "svg_icon": "<svg ...>",
      "versions": [
        {
          "uuid": "2fdead8f-81a2-4a23-9a81-0cf969fe1266",
          "name": "22.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        },
        {
          "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
          "name": "24.04 LTS x64",
          "os_name": "Ubuntu",
          "os_svg_icon": "<svg ...>",
          "is_active": true
        }
      ]
    }
  ]
}

Ховсруулсан: зөвхөн нэг үйлдлийн системийг харуулж SVG тэмдэглэгээг хассан.

Хариултын талбарууд

Газар Төрөл Тодорхойлолт
id integer Ажиллах системийн тодорхойлогч
name string Дистрибьюцийн нэр, жишээ нь Ubuntu эсвэл Debian
svg_icon string Логоны SVG-ийн дотоод тэмдэглэгээ (URL биш)
versions array Та идэвхтэй хувилбаруудыг суулгаж болно
versions[].uuid string Серверийг үүсгэхдээ operating_system_version_uuid гэж ашиглах
versions[].name string Верс болон архитектур, жишээ нь 24.04 LTS x64
versions[].os_name, versions[].os_svg_icon string Эх ОС- ын нэр ба дүрс
versions[].is_active boolean Энэ хувилбарыг шинэ серверүүдэд ашиглах эсэх

Хариу үйлдлийн төлөвийн кодууд

200 Үйл ажиллагааны системийн жагсаалт амжилттай олж авсан
403 API-ийн түлхүүр алга, эсвэл хүчингүй, эсвэл түлхүүр нь шаардлагатай эрхийг агуулаагүй
АВАХ /api/v1/operating-systems/{id}/

Ажиллах системийг олж авах

Нэг үйлдлийн систем болон түүний идэвхтэй хувилбарыг дээрх талбаруудтай нь эргүүлэн өгнө.

curl -X GET "https://admin.vps.org/api/v1/operating-systems/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Хариу үйлдлийн төлөвийн кодууд

200 Сайн байна
404 Энэ id-тэй үйлдлийн систем байхгүй

Версийг сонгох

Учир нь uuid-ийг хатуу кодлохын оронд үйлдлийн үед хувилбаруудыг нэрээр нь хайж олох боломжтой. Ингэснээр хувилбарууд нэмж, хасах үед ч таны нэгдэл ажиллах болно. Сервер бэлэн болсон үед root-ийн нэвтрэх мэдээллийг дансны эзэнд илгээнэ. Серверийг үүсгэх үед SSH түлхүүр нэмж түлхүүрээр нэвтрэх боломжтой.