Updated 07.8 Resource функция decort_image: управление образом. (markdown)

stSolo
2022-04-01 18:23:20 +03:00
parent 45b297f22d
commit 49a1609317

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