vultr_account_info – Получение информации о счёте Vultr
Новое в версии 2.9.
Описание
- Получить информацию о балансе счёта, платежах и оплатах.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account строка | Значение по умолчанию: "default" | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена. |
| api_endpoint строка | URL конечной точки API (без конечного слэша). Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — https://api.vultr.com, если не указано. | |
| api_key строка | Ключ API Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток повторного выполнения в случае возврата Vultr API кода HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_retry_max_delay целое число добавлен в 2.9 | Задержка повторной попытки в секундах, экспоненциально возрастающая до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP-запроса к Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| validate_certs логическое значение |
| Проверять SSL-сертификаты Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Get Vultr account infos
vultr_account_info:
register: result
- name: Print the infos
debug:
var: result.vultr_account_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| vultr_account_info сложный тип | успех | Ответ от Vultr API | |
| balance число с плавающей точкой | успех | Баланс вашего счёта. Пример: -214.69 | |
| last_payment_amount число с плавающей точкой | успех | Сумма последней транзакции платежа. Пример: -250.0 | |
| last_payment_date строка | успех | Дата последнего платежа. Пример: 2017-08-26 12:47:48 | |
| pending_charges число с плавающей точкой | успех | Ожидаемые платежи. Пример: 57.03 | |
| vultr_api сложный тип | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Используемый счёт в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Используемая конечная точка для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число добавлен в 2.9 | успех | Задержка повторной попытки в секундах при экспоненциальном увеличении до этого максимального значения. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- René Moser (@resmo)
Подсказка
Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_account_info_module.html
