Spec-Zone.ru › Ansible

Модуль 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 (без завершающей косой черты).

Резервная переменная окружения VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / обязательный

Ключ API для Vultr API.

Резервная переменная окружения VULTR_API_KEY.

api_results_per_page

integer

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

При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API.

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

Максимальное значение для Vultr API — 500.

Резервная переменная окружения VULTR_API_RESULTS_PER_PAGE.

По умолчанию: 100

api_retries

integer

Количество повторных попыток в случае, если Vultr API возвращает код ошибки 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-запросов к Vultr API.

Резервная переменная окружения VULTR_API_TIMEOUT.

По умолчанию: 180

validate_certs

boolean

Проверять SSL-сертификаты Vultr API.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • См. также документацию 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.

Возвращается: при успехе

Пример: "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_info

list / elements=string

Ответ Vultr API в виде списка.

Возвращается: при успехе

cluster_id

integer

Идентификатор кластера, в котором расположено это объектное хранилище.

Возвращается: при успехе

Пример: 2

date_created

string

Дата создания объектного хранилища.

Возвращается: при успехе

Пример: "2023-02-06T16:41:48+00:00"

id

string

Идентификатор объектного хранилища.

Возвращается: при успехе

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

label

string

Метка объектного хранилища.

Возвращается: при успехе

Пример: "my object store"

region

string

Регион, в котором расположено объектное хранилище.

Возвращается: при успехе

Пример: "ewr"

s3_access_key

string

Ключ доступа к объектному хранилищу.

Возвращается: при успехе

Пример: "00example11223344"

s3_hostname

string

Имя хоста кластера для этого объектного хранилища.

Возвращается: при успехе

Пример: "ewr1.vultrobjects.com"

s3_secret_key

string

Секретный ключ объектного хранилища.

Возвращается: при успехе

Пример: "00example1122334455667788990011"

status

string

Статус развертывания объектного хранилища.

Возвращается: при успехе

Пример: "active"

Авторы

  • 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API