diff --git a/06.01.03-Data-функция-decort_disk-получение-информации-о-диске.md b/06.01.03-Data-функция-decort_disk-получение-информации-о-диске.md index baf9c44..82a206d 100644 --- a/06.01.03-Data-функция-decort_disk-получение-информации-о-диске.md +++ b/06.01.03-Data-функция-decort_disk-получение-информации-о-диске.md @@ -5,44 +5,69 @@ _Data source_ функция **decort_disk** принимает следующи | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| name | string | :x: | Имя диска, по которому требуется получить информацию. Имя диска не может быть пустым.
Диск идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени диска или по его идентификатору (`disk_id`).
Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются.
Обратите внимание, что имя диска НЕ является уникальным, и если в рамках указанного подписчика есть несколько дисков с одним и тем же названием, то будет выдана информация по первому из них. | -| disk_id | int | :x: | Идентификатор диска, по которому требуется получить информацию. Идентификатор не может быть нулевым.
Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются. | -| account_id | int | :x: | Идентификатор подписчика ("account"), которому принадлежит данный диск. Не может быть нулевым.
Данный параметр игнорируется, если задан `disk_id`. | - -Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа. - -Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). +| disk_id | int | :heavy_check_mark: | Идентификатор диска | ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения: | Параметр | Тип | Описание | | --- | --- | --- | -| account_id | int | Уникальный идентификатор подписчика-владельца диска. | -| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск. | -| description | string | Текстовое описание диска. | +| account_id | int | Уникальный идентификатор подписчика-владельца диска | +| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск | +| boot_partition | int | Кол-во разделов диска | +| compute_id | int | Идентификатор compute (виртуальной машины) | +| compute_name | string | Название compute (виртуальной машины) | +| created_time | int | Время создания | +| deleted_time | int | Время удаления | +| desc | string | Текстовое описание диска | +| destruction_time | int | Время окончательного удаления | +| devicename | string | Наименование устройства | | disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. | -| id | int | Идентификатор диска. | -| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа. | -| name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. | -| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск. | -| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск. | -| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений. | -| size | int | Размер диска в ГБ. | -| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data"). | +| disk_path | string | Адрес диска | +| gid | int | Идентификатор площадки (grid id) | +| guid | int | Идентификатор диска | +| id | int | Идентификатор диска | +| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа | +| images | []int | Идентификаторы образов, использующих диск | +| iotune | Struct{
read_bytes_sec int
read_bytes_sec_max int
read_iops_sec int
read_iops_sec_max int
size_iops_sec int
total_bytes_sec int
total_bytes_sec_max int
total_iops_sec int
total_iops_sec_max int
write_bytes_sec int
write_bytes_sec_max int
write_iops_sec int
write_iops_sec_max int
} | Информация об ограничениях IO диска
Кол-во байт для чтения в секунду
Максимальное кол-во байт для чтения
 
Кол-во операций чтения io в секунду
Максимальное число io операций чтения
Размер io операций
Общий размер байт в секунду
Максимальный общий размер байт в секунду
 
Общее кол-во io операций в секунду
Максимальное общее кол-во io операций в секунду
 
Кол-во байт для записи в секунду
Максимальное кол-во байт для записи в секунду
 
Кол-во операций записи в секунду
Максимальное число операций записей
 
 
| +| iqn | string | iqn диска | +| login | string | Логин для доступа к диску | +| milestones | int | Вехи | +| disk_name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. | +| order | int | Номер диска | +| params | string | Параметры диска | +| parent_id | int | id родительского диска | +| passwd | string | Пароль для доступа к диску | +| pci_slot | int | id pci слота, к которому подключен диск | +| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск | +| purge_attempts | int | Кол-во попыток удаления | +| purge_time | int | Время последней попытки | +| reality_device_number | int | Реальный номер устройства | +| reference_id | int | id ссылки на диск | +| res_id | int | id ресурса | +| res_name | string | Наименование ресурса | +| role | string | Роль диска | +| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск | +| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений | +| size_max | int | Размер диска в ГБ | +| size_used | int | Кол-во используемого места, в ГБ | +| snapshots | []Struct{
guid string
label string
res_id string
snap_set_guid string
snap_set_time int
timestamp int
} | Снимки состояния диска
id снимка
Наименование снимка
Ссылка на снимок
Установленный id снимка
Установленное время снимка
Время снимка
 
| +| status | string | Статус диска | +| tech_status | string | Технический статус диска | +| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:
"B" - признак загрузочного диска ("boot").
"D" - признак дополнительного диска ("data") | +| vmid | int | Идентификатор виртуальной машины (устаревшее) | ## Пример использования Пример вызова _data source_ функции **decort_disk**: ```terraform data "decort_disk" "my_data_disk" { - name = "Data01" # this is the name of pre-existing disk - account_id = 100 # this is the ID of the account, where disk named "Data01" is found + disk_id = 33333 } # Once the above directive completes, disk ID will be accessible as -# data.decort_disk.my_data_disk.id +# data.decort_disk.my_data_disk ``` Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). -После успешного завершения такого вызова **decort_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `data.decort_disk.my_data_disk.id` \ No newline at end of file +После успешного завершения такого вызова **decort_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения наименования диска следует использовать конструкцию `data.decort_disk.my_data_disk.disk_name` \ No newline at end of file