Модуль vultr.cloud.account_info — получение информации об учетной записи Vultr
Примечание
Этот модуль входит в коллекцию vultr.cloud (версия 1.14.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 string | URL конечной точки API (без завершающей косой черты). Резервная переменная окружения По умолчанию: |
api_key string / обязательный | Ключ API Vultr. Резервная переменная окружения |
api_results_per_page integer добавлено в vultr.cloud 1.14.0 | При получении большого количества ресурсов укажите, сколько результатов следует возвращать за один вызов API. Это не определяет общее количество возвращаемых результатов: возвращаются все ресурсы с учетом остальных фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения По умолчанию: |
api_retries integer | Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 — слишком много запросов; 500 — внутренняя ошибка сервера; 504 — превышено время ожидания ответа шлюза. Резервная переменная окружения По умолчанию: |
api_retry_max_delay integer | Задержка между повторными попытками увеличивается экспоненциально до указанного максимального значения в секундах. Резервная переменная окружения По умолчанию: |
api_timeout integer | Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения По умолчанию: |
validate_certs boolean | Проверять SSL-сертификаты API Vultr. Варианты:
|
Примечания
Примечание
- См. также документацию 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 dictionary | Ответ API Vultr. Возвращается: при успешном выполнении |
|
balance float |
Баланс учетной записи. Возвращается: при успешном выполнении Пример: |
|
last_payment_amount float |
Сумма последнего платежа. Возвращается: при успешном выполнении Пример: |
|
last_payment_date string |
Дата последнего платежа. Возвращается: при успешном выполнении Пример: |
|
pending_charges float |
Начисления, ожидающие обработки. Возвращается: при успешном выполнении Пример: |
vultr_api dictionary | Ответ API Vultr с некоторыми дополнениями и изменениями. Возвращается: при успешном выполнении |
|
api_account string |
Учетная запись, указанная в файле ini для выбора ключа. Возвращается: при успешном выполнении Пример: |
|
api_endpoint string |
Конечная точка, используемая для запросов API. Возвращается: при успешном выполнении Пример: |
|
api_results_per_page integer |
Количество результатов, возвращаемых за один вызов API. Возвращается: при успешном выполнении Пример: |
|
api_retries integer |
Максимальное количество повторных попыток для запросов API. Возвращается: при успешном выполнении Пример: |
|
api_retry_max_delay integer |
Максимальная задержка в секундах между повторными попытками при экспоненциальном увеличении интервала. Возвращается: при успешном выполнении Пример: |
|
api_timeout integer |
Тайм-аут, используемый для запросов API. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vultr/cloud/account_info_module.html
