Перейти к содержанию

Хостинг /v2/

Список контейнеров

URL: /api/v2/hosting/containers/
Метод: GET
Результат: JSON

Параметры запроса

Необязательные параметры:

  • offset: int – Индекс первой строки выборки, начиная с 0
  • limit: int – Количество элементов в выборке в диапазоне от 1 до 100
  • order: Sequence[str] – Сортировка элементов в выборке
  • filter: str – Фильтр для запроса

Коды ответов

Код Описание
200 Успешный запрос

Возвращаемое значение

  • count: int – Количество элементов
  • entities – Список контейнеров
    • id: int – Идентификатор контейнера
    • uid: str – Логин контейнера, например, c234
    • name: str – Имя контейнера
    • server_name: str – Имя сервера
    • server_ip: str – IP-адрес сервера
    • memory: int – Объем оперативной памяти (МБ)
    • disk: int – Объем дискового пространства (МБ)
    • state: str – Текущее состояние:
      • Active – Включен
      • Stopped – Выключен
      • Building – Создание
      • Starting – Запуск
      • Stopping – Остановка
      • Updating – Обновление настроек
      • StoppedByAdmin – Выключен администратором
      • StoppedByService – Выключен за неуплату
      • StoppedByQuota – Выключен по превышению квоты
      • Backuping – Резервное копирование
      • Restoring – Восстановление
      • Error – Ошибка
      • Migrating – Миграция
      • AntivirusScan – Сканирование антивирусом
    • created: datetime – Дата создания
    • updated: datetime – Дата изменения
    • environment: str – Версия окружения:
      • WHEEZY – Виртуальный хостинг (старое окружение)
      • STRETCH – Облачный хостинг (архивное окружение)
      • BUSTER – Облачный хостинг (архивное окружение)
      • BOOKWORM – Облачный хостинг (современное окружение)
    • memcache: int – Объём памяти memcache (МБ)
    • redis: int – Объём памяти redis (МБ)
    • is_in_transfer: bool – Нахождение контейнера в процессе передачи на другой аккаунт

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

curl --request GET 'https://api-ms.netangels.ru/api/v2/hosting/containers/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Создание контейнера

URL: /api/v2/hosting/containers/
Метод: POST
Результат: JSON

Параметры тела запроса

Обязательные параметры:

  • name: str – Название контейнера
  • memory: int – Ограничение оперативной памяти (МБ)
  • disk: int – Ограничение дискового пространства (МБ)

Необязательные параметры:

  • redis: int – Объем оперативной памяти для Redis (МБ)
  • memcache: int – Объем оперативной памяти для Memcache (МБ)
  • password: str – Пароль для доступа по SSH
  • environment: str – Версия окружения:
    • STRETCH – Облачный хостинг (архивное окружение)
    • WHEEZY – Виртуальный хостинг (старое окружение)
    • BUSTER – Облачный хостинг (архивное окружение)
    • BOOKWORM – Облачный хостинг (современное окружение)
  • create_packet: bool – Создавать пакет?

Коды ответов

Код Описание
201 Успешный запрос
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Контейнер

  • id: int – Идентификатор контейнера
  • uid: str – Логин контейнера, например, c234
  • name: str – Имя контейнера
  • server_name: str – Имя сервера
  • server_ip: str – IP-адрес сервера
  • memory: int – Объем оперативной памяти (МБ)
  • disk: int – Объем дискового пространства (МБ)
  • state: str – Текущее состояние:
    • Active – Включен
    • Stopped – Выключен
    • Building – Создание
    • Starting – Запуск
    • Stopping – Остановка
    • Updating – Обновление настроек
    • StoppedByAdmin – Выключен администратором
    • StoppedByService – Выключен за неуплату
    • StoppedByQuota – Выключен по превышению квоты
    • Backuping – Резервное копирование
    • Restoring – Восстановление
    • Error – Ошибка
    • Migrating – Миграция
    • AntivirusScan – Сканирование антивирусом
  • created: datetime – Дата создания
  • updated: datetime – Дата изменения
  • environment: str – Версия окружения:
    • WHEEZY – Виртуальный хостинг (старое окружение)
    • STRETCH – Облачный хостинг (архивное окружение)
    • BUSTER – Облачный хостинг (архивное окружение)
    • BOOKWORM – Облачный хостинг (современное окружение)
  • memcache: int – Объём памяти memcache (МБ)
  • redis: int – Объём памяти redis (МБ)
  • is_in_transfer: bool – Нахождение контейнера в процессе передачи на другой аккаунт

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

curl --request POST 'https://api-ms.netangels.ru/api/v2/hosting/containers/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "Мои сайты", 
          "memory": 512, 
          "disk": 5120, 
          "redis": 512, 
          "memcache": 512 
    }'

Информация о контейнере

URL: /api/v2/hosting/containers/{id}/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int – ID контейнера

Коды ответов

Код Описание
200 Успешный запрос
404 Контейнер не найден

Возвращаемое значение

Контейнер

  • id: int – Идентификатор контейнера
  • uid: str – Логин контейнера, например, c234
  • name: str – Имя контейнера
  • server_name: str – Имя сервера
  • server_ip: str – IP-адрес сервера
  • memory: int – Объем оперативной памяти (МБ)
  • disk: int – Объем дискового пространства (МБ)
  • state: str – Текущее состояние:
    • Active – Включен
    • Stopped – Выключен
    • Building – Создание
    • Starting – Запуск
    • Stopping – Остановка
    • Updating – Обновление настроек
    • StoppedByAdmin – Выключен администратором
    • StoppedByService – Выключен за неуплату
    • StoppedByQuota – Выключен по превышению квоты
    • Backuping – Резервное копирование
    • Restoring – Восстановление
    • Error – Ошибка
    • Migrating – Миграция
    • AntivirusScan – Сканирование антивирусом
  • created: datetime – Дата создания
  • updated: datetime – Дата изменения
  • environment: str – Версия окружения:
    • WHEEZY – Виртуальный хостинг (старое окружение)
    • STRETCH – Облачный хостинг (архивное окружение)
    • BUSTER – Облачный хостинг (архивное окружение)
    • BOOKWORM – Облачный хостинг (современное окружение)
  • memcache: int – Объём памяти memcache (МБ)
  • redis: int – Объём памяти redis (МБ)
  • is_in_transfer: bool – Нахождение контейнера в процессе передачи на другой аккаунт

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

curl --request GET 'https://api-ms.netangels.ru/api/v2/hosting/containers/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Обновление контейнера

URL: /api/v2/hosting/containers/{id}/
Метод: PUT
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int – ID контейнера

Параметры тела запроса

Необязательные параметры:

  • name: str – Название контейнера
  • memory: int – Ограничение оперативной памяти (МБ)
  • disk: int – Ограничение дискового пространства (МБ)
  • redis: typing.Optional[int] – Объем оперативной памяти для Redis (МБ)
  • memcache: typing.Optional[int] – Объем оперативной памяти для Memcache (МБ)
  • update_packet: bool – Обновлять пакет?

Коды ответов

Код Описание
201 Успешный запрос
404 Контейнер не найден
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Контейнер

  • id: int – Идентификатор контейнера
  • uid: str – Логин контейнера, например, c234
  • name: str – Имя контейнера
  • server_name: str – Имя сервера
  • server_ip: str – IP-адрес сервера
  • memory: int – Объем оперативной памяти (МБ)
  • disk: int – Объем дискового пространства (МБ)
  • state: str – Текущее состояние:
    • Active – Включен
    • Stopped – Выключен
    • Building – Создание
    • Starting – Запуск
    • Stopping – Остановка
    • Updating – Обновление настроек
    • StoppedByAdmin – Выключен администратором
    • StoppedByService – Выключен за неуплату
    • StoppedByQuota – Выключен по превышению квоты
    • Backuping – Резервное копирование
    • Restoring – Восстановление
    • Error – Ошибка
    • Migrating – Миграция
    • AntivirusScan – Сканирование антивирусом
  • created: datetime – Дата создания
  • updated: datetime – Дата изменения
  • environment: str – Версия окружения:
    • WHEEZY – Виртуальный хостинг (старое окружение)
    • STRETCH – Облачный хостинг (архивное окружение)
    • BUSTER – Облачный хостинг (архивное окружение)
    • BOOKWORM – Облачный хостинг (современное окружение)
  • memcache: int – Объём памяти memcache (МБ)
  • redis: int – Объём памяти redis (МБ)
  • is_in_transfer: bool – Нахождение контейнера в процессе передачи на другой аккаунт

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/hosting/containers/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "Мои сайты", 
          "memory": 512, 
          "disk": 5120, 
          "redis": 512, 
          "memcache": 512 
    }'

Удаление контейнера

URL: /api/v2/hosting/containers/{id}/
Метод: DELETE
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int – ID контейнера

Коды ответов

Код Описание
200 Успешный запрос
400 Удаление запрещено
404 Контейнер не найден

Возвращаемое значение

Контейнер

  • id: int – Идентификатор контейнера
  • uid: str – Логин контейнера, например, c234
  • name: str – Имя контейнера
  • server_name: str – Имя сервера
  • server_ip: str – IP-адрес сервера
  • memory: int – Объем оперативной памяти (МБ)
  • disk: int – Объем дискового пространства (МБ)
  • state: str – Текущее состояние:
    • Active – Включен
    • Stopped – Выключен
    • Building – Создание
    • Starting – Запуск
    • Stopping – Остановка
    • Updating – Обновление настроек
    • StoppedByAdmin – Выключен администратором
    • StoppedByService – Выключен за неуплату
    • StoppedByQuota – Выключен по превышению квоты
    • Backuping – Резервное копирование
    • Restoring – Восстановление
    • Error – Ошибка
    • Migrating – Миграция
    • AntivirusScan – Сканирование антивирусом
  • created: datetime – Дата создания
  • updated: datetime – Дата изменения
  • environment: str – Версия окружения:
    • WHEEZY – Виртуальный хостинг (старое окружение)
    • STRETCH – Облачный хостинг (архивное окружение)
    • BUSTER – Облачный хостинг (архивное окружение)
    • BOOKWORM – Облачный хостинг (современное окружение)
  • memcache: int – Объём памяти memcache (МБ)
  • redis: int – Объём памяти redis (МБ)
  • is_in_transfer: bool – Нахождение контейнера в процессе передачи на другой аккаунт

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

curl --request DELETE 'https://api-ms.netangels.ru/api/v2/hosting/containers/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"