diff --git a/07.8-Resource-функция-decort_image:-управление-образом..md b/07.8-Resource-функция-decort_image:-управление-образом..md index a1f9512..de30582 100644 --- a/07.8-Resource-функция-decort_image:-управление-образом..md +++ b/07.8-Resource-функция-decort_image:-управление-образом..md @@ -5,29 +5,29 @@ _Resource_ функция **decort_image** служит для управлен ## Аргументы _Resource_ функция **decort_image** для создания образа принимает следующие аргументы: -| Аргумент | Тип | Описание | -| --- | --- | --- | -| name | string | Обязательный параметр, имя образа
При изменении - изменяет название образа| -| url | string | Обязательный параметр, адрес образа | -| gid | int | Обязательный параметр, grid id образа | -| boot_type | string | Обязательный параметр, тип загрузки образа,
возможные варианты: "bios" или "uefi"| -| image_type | string | Обязательный параметр, тип образа,
возможные варианты - "linux", "windows"| -| drivers | []string | Обязательный параметр, драйвера,
возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] | -| account_id | int | Опциональный параметр,
id аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | -| username | string | Опциональный параметр, имя пользователя,
может быть использован как при создании, так и редактировании образа | -| password | string | Опциональный параметр, пароль пользователя,
может быть использован как при создании, так и редактировании образа | -| username_dl | string | Опциональный параметр,
имя пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | -| password_dl | string | Опциональный параметр,
пароль пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | -| sync | bool | Опциональный параметр, синхронное создание образа, используется при создании | -| sep_id | int | Опциональный параметр, id storage endpoint | -| pool_name | string | Опциональный параметр, пул для создания образа | -| architecture | string | Опциональный параметр, используется при создании,
архитектура системы образа
доступные значения: "X86_64"
по-умолчанию "X86_64" | +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| name | string | :heavy_check_mark: | Имя образа
При изменении - изменяет название образа| +| url | string | :heavy_check_mark: | Адрес образа | +| gid | int | :heavy_check_mark: | Grid id образа | +| boot_type | string | :heavy_check_mark: | Тип загрузки образа,
возможные варианты: "bios" или "uefi"| +| image_type | string | :heavy_check_mark: | Тип образа,
возможные варианты - "linux", "windows"| +| drivers | []string | :heavy_check_mark: | Драйвера,
возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] | +| account_id | int | :x: |ID аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | +| username | string | :x: | Имя пользователя,
может быть использован как при создании, так и редактировании образа | +| password | string | :x: | Пароль пользователя,
может быть использован как при создании, так и редактировании образа | +| username_dl | string | :x: | Имя пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | +| password_dl | string | :x: | Пароль пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | +| sync | bool | :x: | Синхронное создание образа, используется при создании | +| sep_id | int | :x: | ID storage endpoint | +| pool_name | string | :x: | Пул для создания образа | +| architecture | string | :x: | Используется при создании,
архитектура системы образа
доступные значения: "X86_64"
по-умолчанию "X86_64" | | enabled | bool | Опциональный параметр,
доступность образа,
используется при редактировании ресурса | -| shared_with | []int | Опциональный параметр,
настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | -| computeci_id | int | Опциональный параметр,
установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | -| enabled_stacks | []string | Опциональный параметр,
доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | -| permanently | bool | Опциональный параметр,
мгновенное удаление
можно использовать перед удалением | -| reason | string | Опциональный параметр,
причина удаления
можно использовать перед удалением | +| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | +| computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | +| enabled_stacks | []string | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | +| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | +| reason | string | :x: | Причина удаления
можно использовать перед удалением | ## Возвращаемые значения В случае успешного выполнения _resource_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения: @@ -35,42 +35,42 @@ _Resource_ функция **decort_image** для создания образа | Параметр | Тип | Описание | | --- | --- | --- | | account_id | int | accountId привязки образа | -| architecture | string | архитектура образа, возможен вариант X86_64 или PPC64_LE | -| boot_type | string | тип запуска ОС - bios или uefi | -| bootable | bool | является ли образ загрузочным | -| computeci_id | int | id вычислительного ресурса | -| desc | string | описание образа | -| drivers | []string | список используемых драйверов | -| enabled | bool | доступность образа | -| gid | int | id платформы, где образ будет создан | -| guid | int | внутренний id образа, совпадает с image_id | -| history | object{id: int, guid: int, timestamp: int} | история обновлений образа | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| computeci_id | int | ID вычислительного ресурса | +| desc | string | Описание образа | +| drivers | []string | Список используемых драйверов | +| enabled | bool | Доступность образа | +| gid | int | ID платформы, где образ будет создан | +| guid | int | Внутренний id образа, совпадает с image_id | +| history | object{id: int, guid: int, timestamp: int} | История обновлений образа | | hot_resize | bool | Использует ли машина горячее изменение размера образа | | image_type | string | Тип образа: linux, windows или другой | -| last_modified | int | дана последнего изменения | -| link_to | int | привязка к образу, используется в виртуальных образах | -| meta | []string | мета информация об образе | -| milestones | int | описание скоро будет | -| name | string | название образа | -| password | string | пароль для образа | -| password_dl | string | пароль для загрузки двоичных файлов | +| last_modified | int | Дата последнего изменения | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| meta | []string | Мета информация об образе | +| milestones | int | Описание скоро будет | +| name | string | Название образа | +| password | string | Пароль для образа | +| password_dl | string | Пароль для загрузки двоичных файлов | | permanently | bool | Удаление образа: мгновенное или нет | -| pool_name | string | пул, в котором был создан образ | -| provider_name | string | наименование провайдера | -| purge_attempts | int | описание скоро будет | -| reference_id | string | id ссылки | -| res_id | string | id ресурса | -| res_name | string | наименование ресурса | +| pool_name | string | Пул, в котором был создан образ | +| provider_name | string | Наименование провайдера | +| purge_attempts | int | Попытки | +| reference_id | string | ID ссылки | +| res_id | string | ID ресурса | +| res_name | string | Наименование ресурса | | rescuecd | bool | cd или нет | | sep_id | int | storage endpoint provider ID | -| size | int | размер образа | -| status | string | статус образа | -| tech_status | string | технический статус | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | | unc_path | string | unc path | -| url | string | адрес, которого осуществлялась загрузка образа | -| username | string | имя пользователя образа | -| username_dl | string | имя пользователя для загрузки двоичных файлов | -| version | string | версия | +| url | string | Адрес, которого осуществлялась загрузка образа | +| username | string | Имя пользователя образа | +| username_dl | string | Имя пользователя для загрузки двоичных файлов | +| version | string | Версия |