Add a data decort_snapshot_list page, add a description

stSolo
2022-03-30 15:55:54 +03:00
parent e45e363a09
commit d21b41e800

35
06.11.md Normal file

@@ -0,0 +1,35 @@
Функция доступна в провайдере версии 2.1 и выше.
_Data source_ функция **decort_snapshot_list** служит для получения информации об имеющихся снапшотах у переданной в аргументах вычислительной платформы. Снапшот позволяет делать снимки данных с диска, а после этого их восстанавливать. Для успешного восстановления данных через снапшот, необходимо убедиться, что [compute](link will available soon) (вычислительные мощности) остановлен.
## Аргументы
_Data source_ функция **decort_snapshot_list** принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| compute_id | int | Обязательный параметр, id вычислительной мощности |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_snapshot_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| guid | string | guid снапшота |
| label | string | наименование снапшота |
| timestamp | int | время создания снапшота |
| disks | []int | диски снапшота |
## Пример использования
Пример вызова _data source_ функции **decort_snapshot_list**:
```terraform
data "decort_snapshot_list" "sl" {
compute_id = 24074
}
# once the above directive completes, snapshot list will be accessible
# as data.decort_snapshot_list.sl.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_snapshot_list** в переменной `data.decort_snapshot_list.sl` будут сохранены возвращаемые значения.