Модуль vultr.cloud.object_storage_info — получение информации об объектных хранилищах Vultr
Примечание
Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vultr.cloud.
Чтобы использовать коллекцию в плейбуке, укажите: vultr.cloud.object_storage_info.
Добавлено в vultr.cloud 1.14.0
Краткое описание
- Получение информации о доступных объектных хранилищах.
Параметры
Параметр | Комментарии |
|---|---|
api_endpoint string | URL конечной точки API (без завершающей косой черты). Резервная переменная окружения По умолчанию: |
api_key string / обязательный | Ключ API для Vultr API. Резервная переменная окружения |
api_results_per_page integer добавлено в vultr.cloud 1.14.0 | При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учетом других фильтров. Максимальное значение для Vultr API — 500. Резервная переменная окружения По умолчанию: |
api_retries integer | Количество повторных попыток в случае, если Vultr API возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error, 504 Gateway Time-out. Резервная переменная окружения По умолчанию: |
api_retry_max_delay integer | Экспоненциальная задержка между повторными попытками в секундах увеличивается до указанного максимального значения. Резервная переменная окружения По умолчанию: |
api_timeout integer | Тайм-аут HTTP-запросов к Vultr API. Резервная переменная окружения По умолчанию: |
validate_certs boolean | Проверять SSL-сертификаты Vultr API. Варианты:
|
Примечания
Примечание
- См. также документацию API: https://www.vultr.com/api/.
Примеры
- name: Get Vultr object_storage infos
vultr.cloud.object_storage_info:
register: result
- name: Print the infos
ansible.builtin.debug:
var: result.vultr_object_storage_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
vultr_api dictionary | Ответ Vultr API с несколькими дополнениями и изменениями. Возвращается: при успехе |
|
api_endpoint string |
Конечная точка, использованная для запросов API. Возвращается: при успехе Пример: |
|
api_results_per_page integer |
Количество результатов, возвращаемых за один вызов API. Возвращается: при успехе Пример: |
|
api_retries integer |
Максимальное количество повторных попыток запросов API. Возвращается: при успехе Пример: |
|
api_retry_max_delay integer |
Максимальная задержка экспоненциального ожидания в секундах между повторными попытками. Возвращается: при успехе Пример: |
|
api_timeout integer |
Тайм-аут, используемый для запросов API. Возвращается: при успехе Пример: |
vultr_object_storage_info list / elements=string | Ответ Vultr API в виде списка. Возвращается: при успехе |
|
cluster_id integer |
Идентификатор кластера, в котором расположено это объектное хранилище. Возвращается: при успехе Пример: |
|
date_created string |
Дата создания объектного хранилища. Возвращается: при успехе Пример: |
|
id string |
Идентификатор объектного хранилища. Возвращается: при успехе Пример: |
|
label string |
Метка объектного хранилища. Возвращается: при успехе Пример: |
|
region string |
Регион, в котором расположено объектное хранилище. Возвращается: при успехе Пример: |
|
s3_access_key string |
Ключ доступа к объектному хранилищу. Возвращается: при успехе Пример: |
|
s3_hostname string |
Имя хоста кластера для этого объектного хранилища. Возвращается: при успехе Пример: |
|
s3_secret_key string |
Секретный ключ объектного хранилища. Возвращается: при успехе Пример: |
|
status string |
Статус развертывания объектного хранилища. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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/object_storage_info_module.html