Модуль google.cloud.gcp_compute_backend_bucket_info — сбор информации о GCP BackendBucket
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если в качестве типа учётных данных указано accesstoken. |
auth_kind string / обязательный | Тип используемых учётных данных. Варианты:
|
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он влияет только на строку User Agent для запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое JSON-файла учётной записи службы: словарь или строка JSON, представляющая это содержимое. |
service_account_email string | Необязательный адрес электронной почты учётной записи службы. Используется, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к 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 |
Максимальное количество секунд, в течение которых ответ на запрос подписанного URL считается актуальным. По истечении этого периода ответ будет повторно проверен перед отправкой. При отправке ответов на запросы подписанных URL Cloud CDN будет внутренне вести себя так, как если бы все ответы от этого бэкенда содержали заголовок “Cache-Control: public, max-age=[TTL]”, независимо от наличия заголовка Cache-Control. Фактически отправляемые в ответах заголовки не изменяются. Возвращается: при успешном выполнении |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
customResponseHeaders list / элементы=string |
Заголовки, которые балансировщик нагрузки HTTP/S должен добавлять к проксируемым ответам. Возвращается: при успешном выполнении |
|
description string |
Необязательное текстовое описание ресурса, предоставляемое клиентом при создании ресурса. Возвращается: при успешном выполнении |
|
enableCdn boolean |
Если значение равно true, включить Cloud CDN для этого BackendBucket. Возвращается: при успешном выполнении |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса. Задаётся клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы, кроме последнего, должны быть дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/google/cloud/gcp_compute_backend_bucket_info_module.html