Модуль vultr.cloud.account_info – Получение информации об аккаунте Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install vultr.cloud.

Для использования в плейбуке укажите: vultr.cloud.account_info.

Новое в vultr.cloud 1.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации о балансе счета, платежах и счетах.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без конечной косой черты). Задает переменную среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Задает переменную среды `VULTR_API_KEY`.
api_retries целое число	Количество попыток при возврате Vultr API HTTP-кода ошибки, таких как - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Тайм-аут шлюза Задает переменную среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Время ожидания повторных попыток в секундах экспоненциально возрастает до этого максимального значения. Задает переменную среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Тайм-аут HTTP-запроса к Vultr API. Задает переменную среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs логический	Проверка SSL-сертификатов Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API по адресу https://www.vultr.com/api/.

Примеры

- name: Get Vultr account infos
  vultr.cloud.account_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_account_info

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
vultr_account_info словарь	Ответ от API Vultr. Возвращено: успех
balance число с плавающей точкой	Баланс вашего счета. Возвращено: успех Пример: `-214.69`
last_payment_amount число с плавающей точкой	Сумма последней транзакции платежа. Возвращено: успех Пример: `-250.0`
last_payment_date строка	Дата последнего платежа. Возвращено: успех Пример: `"2021-11-07T05:57:59-05:00"`
pending_charges число с плавающей точкой	Ожидаемые платежи. Возвращено: успех Пример: `57.03`
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успех
api_account строка	Аккаунт, используемый в файле ini для выбора ключа. Возвращено: успех Пример: `"default"`
api_endpoint строка	Точка доступа, используемая для запросов API. Возвращено: успех Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество попыток повторных запросов API. Возвращено: успех Пример: `5`
api_retry_max_delay целое число	Время экспоненциальной задержки в секундах между повторными попытками до максимального значения этой задержки. Возвращено: успех Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успех Пример: `60`

Авторы

René Moser (@resmo)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/account_info_module.html