Updated 06.01.05 Data функция decort_account получение информации об аккаунте (markdown)
@@ -1,13 +1,11 @@
|
|||||||
_Data source_ функция **decort_account** служит для получения информации о подписчике ("account"), к ресурсам которого имеет доступ данный пользователь. Основной сценарий применения данной функции - получить цифровой идентификатор подписчика по его имени, чтобы в дальнейшем использовать этот идентификатор для управления ресурсами.
|
_Data source_ функция **decort_account** служит для получения информации об аккаунте.
|
||||||
|
|
||||||
## Аргументы
|
## Аргументы
|
||||||
**Внимание:** в качестве параметра должен быть **обязательно** передан хотя бы один из аргументов.
|
_Data source_ функция **decort_account** приниает следующие аргументы:
|
||||||
_Data source_ функция **decort_account** принимает следующие аргументы:
|
|
||||||
|
|
||||||
| Аргумент | Тип | Обязательный | Описание |
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| name | string | :x: | Имя подписчика, по которому требуется получить информацию. Имя не может быть пустым.<br>Вы можете задать или `account_id`, или `name`. Если задан параметр `account_id`, то параметр `name` игнорируется. |
|
| account_id | int | :heavy_check_mark: | Идентификатор аккаунта |
|
||||||
| account_id | int | :x: | Идентификатор подписчика, по которому требуется получить информацию. Не может быть нулевым.<br>Если задан данный параметр, то параметр `name` игнорируется. |
|
|
||||||
|
|
||||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа.
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
@@ -18,21 +16,42 @@ _Data source_ функция **decort_account** принимает следую
|
|||||||
|
|
||||||
| Параметр | Тип | Описание |
|
| Параметр | Тип | Описание |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| account_id | int | Уникальный идентификатор подписчика. |
|
| account_id | int | ID аккаунта |
|
||||||
| account_name | string | Имя подписчика. |
|
| account_name | string | Название аккаунта |
|
||||||
| status | string | Текущий статус подписчика. |
|
| meta | []string | Мета информация |
|
||||||
|
| resources | Struct{<br/>current Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>reserved Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>} | Информация о ресурсах<br/>Задействованные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, MБ<br/><br/>Зарезервированные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, MБ<br/><br/> <br/> |
|
||||||
|
| acl | []Struct{<br/>can_be_deleted bool<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах<br/>Может ли быть удален аккаунт<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/> <br/> |
|
||||||
|
| company | string | Название компании, которой принадлежит аккаунт |
|
||||||
|
| companyurl | string | url-адрес компани |
|
||||||
|
| created_by | string | Пользователь - создателя аккаунта |
|
||||||
|
| created_time | int | Время создания аккаунта |
|
||||||
|
| deactivation_time | float | Время деактивации аккаунта |
|
||||||
|
| deleted_by | string | Пользователь, удаливший аккаунт |
|
||||||
|
| deleted_time | int | Время удаления аккаунта |
|
||||||
|
| displayname | string | Отображаемое имя аккаунта |
|
||||||
|
| guid | int | Внутренний guid аккаунта |
|
||||||
|
| resource_limits | Struct{<br/>cu_c float<br/>cu_d float<br/>cu_i float<br/>cu_m float<br/>cu_np float<br/>gpu_units float<br/>} | Ограничения ресурсов<br/>Кол-во ядер<br/>Размер диска, ГБ<br/>Число публичных ip адресов<br/>Размер RAM, МБ<br/>Объем трафика, ГБ<br/>Кол-вол графических ядер<br/> <br/> |
|
||||||
|
| send_access_emails | bool | Флаг, отправлять ли на указанную почту письмо о доступе |
|
||||||
|
| service_account | bool | Флаг, является ли аккаунт аккаунтом-обслуживания |
|
||||||
|
| status | string | Статус аккаунта |
|
||||||
|
| updated_time | int | Время последнего обновления |
|
||||||
|
| version | int | Версия аккаунта |
|
||||||
|
| vins | []int | Список id виртуальных сетей |
|
||||||
|
| vinses | []int | Список id виртуальных сетей |
|
||||||
|
| computes | Struct{<br/>started int<br/>stopped int <br/>} | Информация о вычислительных мощностях<br/>Кол-во запущенных<br/>Кол-во остановленных<br/> <br/> |
|
||||||
|
| machines | Struct{<br/>halted int<br/>running int <br/>} | Информация о виртуальных машинах (устаревшее)<br/>Кол-во запущенных<br/>Кол-во остановленных<br/> <br/> |
|
||||||
|
|
||||||
## Пример использования
|
## Пример использования
|
||||||
Пример вызова _data source_ функции **decort_account**:
|
Пример вызова _data source_ функции **decort_account**:
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
data "decort_account" "my_account" {
|
data "decort_account" "my_account" {
|
||||||
name = "MyAccount" # this is the name of the account, which ID we want to get
|
account_id = 1111
|
||||||
}
|
}
|
||||||
# Once the above directive completes, accountID will be accessible as
|
# Once the above directive completes, account will be available to
|
||||||
# data.decort_account.my_account.id
|
# data.decort_account.my_account
|
||||||
```
|
```
|
||||||
|
|
||||||
Данный пример подразумевает, что ранее по тексту 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!)).
|
Данный пример подразумевает, что ранее по тексту 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_account** в переменной `data.decort_account.my_account` будут сохранены возвращаемые значения. В частности, для получения идентификатора подписчика следует использовать конструкцию `data.decort_account.my_account.id`
|
После успешного завершения такого вызова **decort_account** в переменной `data.decort_account.my_account` будут сохранены возвращаемые значения.
|
||||||
Reference in New Issue
Block a user