Просмотр списка образов

Запрос

Для того, чтобы получить информацию о тарифах, необходимо отправить запрос типа GET на /v2/images с указанием параметров:

Параметр

Тип

Описание

items_per_page

обязательный

Количество элементов на странице (от 1 до 100)

page

обязательный

Номер страницы пагинатора (минимум 1)

region

обязательный

Регион размещения

type

опциональный

Тип образа

Примечание

В API v2 пагинация обязательна для всех списков, так как полный набор данных может содержать тысячи элементов.

  • Для изменения количества элементов на странице укажите items_per_page от 10 до 100.

  • Используйте параметр page для перехода между страницами (начинается с 1).

  • Полный перебор всех элементов требует последовательных запросов с увеличением номера страницы.

Параметр region может принимать следующие значения:

Значение

Описание

msk1

Архивные тарифы в Москве

openstack-msk1

Тарифы в Москве

openstack-spb1

Тарифы в Санкт-Петербурге

openstack-sam1

Тарифы в Самаре

Параметр type может принимать следующие значения:

Значение

Описание

application

Приложение

backup

Бэкап

distribution

Шаблон чистой ОС

restore

Образ восстановления

snapshot

Снэпшот

Пример запроса:

curl \
-X GET \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
'https://api.cloudvps.reg.ru/v2/images?type=application&items_per_page=10&region=openstack-msk1&page=1'

Ответ

В результате будет возвращён JSON с массивом из 10 образов (в примере показаны только 2):

{
  "images": [
    {
      "created_at": "2023-09-15 12:19:21",
      "distribution": "ubuntu-20.04",
      "id": 1058359,
      "isp_license_size": null,
      "min_disk_size": "0.00",
      "name": "Node.js",
      "private": false,
      "region_slug": "openstack-msk1",
      "size_gigabytes": "1.30",
      "slug": "ubuntu-20-04-amd64-nodejs-18",
      "type": "application"
    },
    {
      "created_at": "2023-10-17 16:03:52",
      "distribution": "ubuntu-20.04",
      "id": 1059747,
      "isp_license_size": null,
      "min_disk_size": "4.88",
      "name": "LEMP",
      "private": false,
      "region_slug": "openstack-msk1",
      "size_gigabytes": "1.72",
      "slug": "ubuntu-20-04-amd64-lemp",
      "type": "application"
    }
  ],
  "metadata": {
    "pages": {
      "current": 1,          // Текущая страница
      "items_per_page": 10,  // Количество элементов на странице
      "total": 1
    },
    "total": 10              // Количество полученных элементов
  }
}

Поля в объекте образа:

Поле

Описание

created_at

Дата создания образа

distribution

Дистрибутив

id

Уникальный идентификатор образа

isp_license_size

Тип лицензии ispmanager

min_disk_size

Минимальный размер диска (ГБ)

name

Имя образа

private

Признак приватности (для шаблонов ОС и приложений — false)

region_slug

Регион

size_gigabytes

Размер образа, ГБ

slug

Уникальный идентификатор образа

type

Тип образа