Create decort_image_list_stacks page, add description
47
06.10-Data-функция-decort_image_list_stacks:-получение-информации-о-доступных-для-образа-stacks.md
Normal file
47
06.10-Data-функция-decort_image_list_stacks:-получение-информации-о-доступных-для-образа-stacks.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
_Data source_ функция **decort_image_list_stacks** служит для получения информации об имеющихся в облачной платформе доступных образу stacks. Образы это дисковые ресурсы, уже содержащие некоторые данные, для которых реализован механизм быстрого клонирования/копирования в новый диск. Stacks - хранилища образов. Из других stacks к образу доступа нет.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_image_list_stacks** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| image_id | int | Обязательный параметр, id образа |
|
||||||
|
| page | int | Опциональный параметр, номер страницы |
|
||||||
|
| size | int | Опциональный параметр, размер страницы |
|
||||||
|
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_image_list_stacks** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| api_key | string | ключ api |
|
||||||
|
| api_url | string | адрес api |
|
||||||
|
| app_id | string | id приложения |
|
||||||
|
| desc | string | описание |
|
||||||
|
| drivers | []string | список драйверов |
|
||||||
|
| error | int | номер ошибки |
|
||||||
|
| guid | int | внутренний id |
|
||||||
|
| id | int | id |
|
||||||
|
| images | []int | список доступных образов на stack |
|
||||||
|
| login | string | логин пользователя |
|
||||||
|
| name | string | наименование stacks |
|
||||||
|
| passwd | string | пароль |
|
||||||
|
| reference_id | string | id ссылки |
|
||||||
|
| status | string | статус |
|
||||||
|
| type | string | тип |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decs_image_list_stacks**:
|
||||||
|
```
|
||||||
|
data "decort_image_list_stacks" "ils" {
|
||||||
|
image_id = 1234
|
||||||
|
#page = 2
|
||||||
|
#size = 3
|
||||||
|
}
|
||||||
|
# once the above directive completes, will be accessible
|
||||||
|
# as data.decort_image_list_stacks.ils.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_image_list_stacks** в переменной `data.decort_image_list_stacks.ils` будут сохранены возвращаемые значения.
|
||||||
Reference in New Issue
Block a user