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

Хостинг /v2/

Список баз данных

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

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

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

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

Коды ответов

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

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

  • count: int – Количество элементов
  • entities – Список баз данных
    • id: int – Идентификатор БД
    • name: str – Имя БД
    • charset: str – Кодировка БД
    • created: datetime – Дата создания БД
    • updated: datetime – Дата изменения БД
    • database_account: JSON – Вложенная структура с аккаунтом БД, которому принадлежит база

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

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

Изменение пароля аккаунта БД

URL: /api/v2/hosting/virtualhosts/{id}/databases/set-password/
Метод: PUT
Результат: JSON

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

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

  • id: int – ID сайта

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

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

  • password: str – Пароль

Коды ответов

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

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

Аккаунт баз данных

  • id: int – Идентификатор аккаунта
  • login: str – Логин аккаунта
  • engine: str – Движок БД
  • engine_version: str – Версия движка БД
  • created: datetime – Дата создания аккаунта
  • updated: datetime – Дата изменения аккаунта
  • virtualhost_id: int – ID сайта, к которому принадлежит аккаунт

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

curl --request PUT 'https://api-ms.netangels.ru/api/v2/hosting/virtualhosts/{id}/databases/set-password/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "password": "укажите-пароль" 
    }'

Создание базы данных

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

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

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

  • virtualhost_id: int – ID сайта
  • name: str – Имя БД
  • charset: str – Кодировка БД

Коды ответов

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

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

База данных

  • id: int – Идентификатор БД
  • name: str – Имя БД
  • charset: str – Кодировка БД
  • created: datetime – Дата создания БД
  • updated: datetime – Дата изменения БД
  • database_account: JSON – Вложенная структура с аккаунтом БД, которому принадлежит база

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

curl --request POST 'https://api-ms.netangels.ru/api/v2/hosting/databases/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "virtualhost_id": 1001, 
          "name": "db_name", 
          "charset": "utf-8" 
    }'

Удаление базы данных

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

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

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

  • id: int – ID базы данных

Коды ответов

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

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

База данных

  • id: int – Идентификатор БД
  • name: str – Имя БД
  • charset: str – Кодировка БД
  • created: datetime – Дата создания БД
  • updated: datetime – Дата изменения БД
  • database_account: JSON – Вложенная структура с аккаунтом БД, которому принадлежит база

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

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