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

Облачные VDS

Получить конфигурационный файл Cloud-init

URL: /api/v1/cloud/cloud-init-configs/{id}/
Метод: GET
Результат: JSON

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

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

  • id: int – ID конфигурационного файла

Коды ответов

Код Описание
200 Успешный запрос
404 Конфигурационный файл не найден

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

Конфигурационный файл Cloud-init

  • id: int – Идентификатор конфигурационного файла
  • name: str – Имя конфигурации
  • comment: str – Комментарий к конфигурации
  • config: str – Конфигурация в формате YAML

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

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

Получить список конфигурационных файлов Cloud-init

URL: /api/v1/cloud/cloud-init-configs/
Метод: GET
Результат: JSON

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

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

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

Коды ответов

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

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

  • count: int – Количество элементов
  • entities – Список конфигурационных файлов
    • id: int – Идентификатор конфигурационного файла
    • name: str – Имя конфигурации
    • comment: str – Комментарий к конфигурации

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

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

Создание конфигурационного файла Cloud-init

URL: /api/v1/cloud/cloud-init-configs/
Метод: POST
Результат: JSON

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

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

  • name: str – Имя файла
  • config: str – Конфигурация в формате YAML

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

  • comment: str – Комментарий

Коды ответов

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

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

Конфигурационный файл Cloud-init

  • id: int – Идентификатор конфигурационного файла
  • name: str – Имя конфигурации
  • comment: str – Комментарий к конфигурации
  • config: str – Конфигурация в формате YAML

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

curl --request POST 'https://api-ms.netangels.ru/api/v1/cloud/cloud-init-configs/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "Моя конфигурация", 
          "config": "#cloud-config\n\n# Стандартный шаблон cloud-init\npackage_update: true\npackage_upgrade: true\n\npackages:\n - git\n - curl\n", 
          "comment": "для БД" 
    }'

Изменение конфигурационного файла Cloud-init

URL: /api/v1/cloud/cloud-init-configs/{id}/
Метод: PUT
Результат: JSON

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

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

  • id: int – ID конфигурационного файла

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

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

  • name: str – Имя файла
  • config: str – Конфигурация в формате YAML

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

  • comment: str – Комментарий

Коды ответов

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

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

Конфигурационный файл Cloud-init

  • id: int – Идентификатор конфигурационного файла
  • name: str – Имя конфигурации
  • comment: str – Комментарий к конфигурации
  • config: str – Конфигурация в формате YAML

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

curl --request PUT 'https://api-ms.netangels.ru/api/v1/cloud/cloud-init-configs/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "Моя конфигурация", 
          "config": "#cloud-config\n\n# Стандартный шаблон cloud-init\npackage_update: true\npackage_upgrade: true\n\npackages:\n - git\n - curl\n", 
          "comment": "для БД" 
    }'

Удаление конфигурационного файла Cloud-init

URL: /api/v1/cloud/cloud-init-configs/{id}/
Метод: DELETE
Результат: JSON

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

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

  • id: int – ID конфигурационного файла

Коды ответов

Код Описание
200 Успешный запрос
404 Конфигурационный файл не найден

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

Конфигурационный файл Cloud-init

  • id: int – Идентификатор конфигурационного файла
  • name: str – Имя конфигурации
  • comment: str – Комментарий к конфигурации
  • config: str – Конфигурация в формате YAML

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

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

Массовое удаление конфигурационных файлов Cloud-init

URL: /api/v1/cloud/cloud-init-configs/
Метод: DELETE
Результат: JSON

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

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

  • ids: Список int – ID конфигураций

Коды ответов

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

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

  • entities – Список конфигурационных файлов
    • id: int – Идентификатор конфигурационного файла
    • name: str – Имя конфигурации
    • comment: str – Комментарий к конфигурации

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

curl --request DELETE 'https://api-ms.netangels.ru/api/v1/cloud/cloud-init-configs/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "ids": [1, 7, 11] 
    }'