Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_backend_bucket_info — Сбор информации о GCP BackendBucket

Примечание

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

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_backend_bucket_info.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Сбор информации о GCP BackendBucket

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

строка

Указывает, в какой среде Ansible выполняется этот модуль.

Не следует устанавливать, если вы не знаете, что делаете.

Это изменяет только строку User Agent для любых запросов к API.

filters

список / элементы=строка

Список пар значений фильтра. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).

project

строка

Проект Google Cloud Platform для использования.

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет.

service_account_email

строка

Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

путь

Путь к файлу JSON учетной записи службы, если тип выбран serviceaccount.

Примечания

Примечание

  • для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
  • значения переменных среды будут использоваться только в том случае, если значения книги задач не установлены.
  • Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a backend bucket
  gcp_compute_backend_bucket_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ

Описание

resources

complex

Список ресурсов

Возвращается: всегда

bucketName

string

Имя корзины Cloud Storage.

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

cdnPolicy

complex

Конфигурация Cloud CDN для этого Backend Bucket.

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

cacheMode

string

Указывает настройку кэша для всех ответов от этого бэкэнда.

Возможные значения: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL и CACHE_ALL_STATIC.

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

clientTtl

integer

Указывает максимально допустимое TTL для кэшированного контента, предоставляемого этим источником.

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

defaultTtl

integer

Указывает TTL по умолчанию для кэшированного контента, предоставляемого этим источником, для ответов, которые не имеют существующего допустимого TTL (max-age или s-max-age).

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

maxTtl

integer

Указывает максимально допустимое TTL для кэшированного контента, предоставляемого этим источником.

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

negativeCaching

boolean

Отрицательное кэширование позволяет устанавливать TTL для каждого кода состояния, чтобы применять точное кэширование для распространенных ошибок или перенаправлений.

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

negativeCachingPolicy

complex

Устанавливает TTL кэша для указанного кода состояния HTTP. Для настройки negativeCachingPolicy необходимо включить negativeCaching.

Пропуск политики и включение negativeCaching будут использовать TTL кэша по умолчанию Cloud CDN.

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

code

integer

Код состояния HTTP для определения TTL. В качестве значений можно указать только коды состояния HTTP 300, 301, 308, 404, 405, 410, 421, 451 и 501, и вы не можете указывать код состояния более одного раза.

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

ttl

integer

TTL (в секундах), для которого кэшируются ответы с соответствующим кодом состояния. Максимально допустимое значение составляет 1800 с (30 минут), обратите внимание, что объекты, к которым редко обращаются, могут быть удалены из кэша до определенного TTL.

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

serveWhileStale

integer

Подавать существующий контент из кэша (если доступен), когда происходит повторная проверка контента с источником или когда возникает ошибка при обновлении кэша.

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

signedUrlCacheMaxAgeSec

integer

Максимальное количество секунд, в течение которых ответ на запрос со ссылкой с подписью будет считаться свежим. После этого периода ответ будет повторно проверен перед подачей.

При подаче ответов на запросы со ссылками с подписью Cloud CDN будет внутренне вести себя так, как будто все ответы от этого бэкэнда имели заголовок «Cache-Control: public, max-age=[TTL]», независимо от любого существующего заголовка Cache-Control. Фактические заголовки, подаваемые в ответах, не будут изменены.

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

creationTimestamp

string

Метка времени создания в текстовом формате RFC3339.

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

customResponseHeaders

list / elements=string

Заголовки, которые балансировщик нагрузки HTTP/S должен добавлять к проксированным ответам.

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

description

string

Необязательное текстовое описание ресурса; предоставляется клиентом при создании ресурса.

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

enableCdn

boolean

Если true, включите Cloud CDN для этого BackendBucket.

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

id

integer

Уникальный идентификатор ресурса.

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

имя

строка

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.

Возвращаемое значение: успех

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

© 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/google/cloud/gcp_compute_backend_bucket_info_module.html

Spec-Zone.ru

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