Модуль vultr.cloud.object_storage_cluster_info — получение сведений о кластерах объектного хранилища Vultr

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: vultr.cloud.object_storage_cluster_info.

Добавлено в vultr.cloud 1.14.0

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

Краткое описание

Получение сведений о доступных кластерах объектного хранилища.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: все ресурсы возвращаются с учетом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Экспоненциальная задержка перед повторной попыткой в секундах увеличивается до этого максимального значения. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять SSL-сертификаты API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Get Vultr object_storage_cluster infos
  vultr.cloud.object_storage_cluster_info:
  register: result

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

Возвращаемые значения

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

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с некоторыми дополнениями и изменениями. Возвращается: при успехе
api_endpoint string	Конечная точка, используемая для запросов API. Возвращается: при успехе Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых за один вызов API. Возвращается: при успехе Пример: `100`
api_retries integer	Максимальное количество повторных попыток выполнения запросов API. Возвращается: при успехе Пример: `5`
api_retry_max_delay integer	Максимальная экспоненциальная задержка в секундах между повторными попытками. Возвращается: при успехе Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращается: при успехе Пример: `60`
vultr_object_storage_cluster_info list / elements=string	Ответ API Vultr в виде списка. Возвращается: при успехе
deploy string	Статус возможности создания новых объектных хранилищ в этом кластере. Возвращается: при успехе Пример: `"True"`
hostname string	Имя хоста кластера для этого объектного хранилища. Возвращается: при успехе Пример: `"ewr1.vultrobjects.com"`
id integer	Идентификатор кластера объектного хранилища. Возвращается: при успехе Пример: `2`
region string	Регион, в котором расположен кластер объектного хранилища. Возвращается: при успехе Пример: `"ewr"`

Авторы

jasites (@jasites)

Ссылки на коллекцию

© 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_cluster_info_module.html