Хостинг

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

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

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

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

  • offset: int - Индекс первой строки выборки, начиная с 0
  • limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

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

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

  • count: int - Количество элементов
  • entities - Список контейнеров
    • id: int - Идентификатор контейнера
    • login: str - Логин контейнера, например, c234
    • name: str - Имя контейнера
    • service_address: str - Имя сервера
    • service_ip: str - IP-адрес сервера
    • memory_limit: int - Объем оперативной памяти (МБ)
    • quota: int - Объем дискового пространства (МБ)
    • state: int - Статус:
      • ENABLED - активен
      • DISABLED_BY_SERVICE - Отключен за неуплату
      • DISABLED_BY_ADMIN - Отключен администратором
      • DISABLED_BY_QUOTA - Отключен за превышение ограничения дискового пространства
    • created: datetime - Дата создания
    • updated: datetime - Дата изменения
    • environment: int - Версия окружения:
      • 0 - Облачный хостинг (современное окружение)
      • 1 - Виртуальный хостинг (старое окружение)
    • virtualhosts: Список virtualhosts - Список сайтов в контейнере
    • memcache: Memcache - Настройки memcache
    • redis: Redis - Настройки redis
    • is_in_transfer: bool - Нахождение контейнера в процессе передачи на другой аккаунт

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

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

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

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

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

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

  • name: str - Название контейнера
  • memory_limit: int - Ограничение оперативной памяти (МБ)
  • quota: int - Ограничение дискового пространства (МБ)
  • environment: int - Версия окружения:
    • 0 - Облачный хостинг (архивное окружение)
    • 1 - Виртуальный хостинг (старое окружение)
    • 2 - Облачный хостинг (современное окружение)

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

  • password: str - Пароль для доступа по SSH
  • redis: int - Объем оперативной памяти для Redis (МБ)
  • memcache: int - Объем оперативной памяти для Memcache (МБ)
  • create_packet: bool - Создавать пакет?

Коды ответов

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

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

Контейнер

  • id: int - Идентификатор контейнера
  • login: str - Логин контейнера, например, c234
  • name: str - Имя контейнера
  • service_address: str - Имя сервера
  • service_ip: str - IP-адрес сервера
  • memory_limit: int - Объем оперативной памяти (МБ)
  • quota: int - Объем дискового пространства (МБ)
  • state: int - Статус:
    • ENABLED - активен
    • DISABLED_BY_SERVICE - Отключен за неуплату
    • DISABLED_BY_ADMIN - Отключен администратором
    • DISABLED_BY_QUOTA - Отключен за превышение ограничения дискового пространства
  • created: datetime - Дата создания
  • updated: datetime - Дата изменения
  • environment: int - Версия окружения:
    • 0 - Облачный хостинг (современное окружение)
    • 1 - Виртуальный хостинг (старое окружение)
  • virtualhosts: Список virtualhosts - Список сайтов в контейнере
  • memcache: Memcache - Настройки memcache
  • redis: Redis - Настройки redis
  • is_in_transfer: bool - Нахождение контейнера в процессе передачи на другой аккаунт

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

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

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

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

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

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

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

Коды ответов

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

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

Контейнер

  • id: int - Идентификатор контейнера
  • login: str - Логин контейнера, например, c234
  • name: str - Имя контейнера
  • service_address: str - Имя сервера
  • service_ip: str - IP-адрес сервера
  • memory_limit: int - Объем оперативной памяти (МБ)
  • quota: int - Объем дискового пространства (МБ)
  • state: int - Статус:
    • ENABLED - активен
    • DISABLED_BY_SERVICE - Отключен за неуплату
    • DISABLED_BY_ADMIN - Отключен администратором
    • DISABLED_BY_QUOTA - Отключен за превышение ограничения дискового пространства
  • created: datetime - Дата создания
  • updated: datetime - Дата изменения
  • environment: int - Версия окружения:
    • 0 - Облачный хостинг (современное окружение)
    • 1 - Виртуальный хостинг (старое окружение)
  • virtualhosts: Список virtualhosts - Список сайтов в контейнере
  • memcache: Memcache - Настройки memcache
  • redis: Redis - Настройки redis
  • is_in_transfer: bool - Нахождение контейнера в процессе передачи на другой аккаунт

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

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

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

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

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

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

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

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

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

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

Коды ответов

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

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

Контейнер

  • id: int - Идентификатор контейнера
  • login: str - Логин контейнера, например, c234
  • name: str - Имя контейнера
  • service_address: str - Имя сервера
  • service_ip: str - IP-адрес сервера
  • memory_limit: int - Объем оперативной памяти (МБ)
  • quota: int - Объем дискового пространства (МБ)
  • state: int - Статус:
    • ENABLED - активен
    • DISABLED_BY_SERVICE - Отключен за неуплату
    • DISABLED_BY_ADMIN - Отключен администратором
    • DISABLED_BY_QUOTA - Отключен за превышение ограничения дискового пространства
  • created: datetime - Дата создания
  • updated: datetime - Дата изменения
  • environment: int - Версия окружения:
    • 0 - Облачный хостинг (современное окружение)
    • 1 - Виртуальный хостинг (старое окружение)
  • virtualhosts: Список virtualhosts - Список сайтов в контейнере
  • memcache: Memcache - Настройки memcache
  • redis: Redis - Настройки redis
  • is_in_transfer: bool - Нахождение контейнера в процессе передачи на другой аккаунт

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

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

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

URL: /api/v1/hosting/containers/{id}/
Метод: DELETE

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

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

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

Коды ответов

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

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

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