Модуль google.cloud.gcp_compute_region_url_map_info — Сбор информации о GCP RegionUrlMap
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_region_url_map_info.
Обзор
- Сбор информации о GCP RegionUrlMap
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип учетных данных, используемых для аутентификации. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Этот параметр следует устанавливать только в том случае, если вы понимаете, что делаете. Он влияет только на строку User Agent при любых запросах к API. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform, который нужно использовать. |
region строка / обязательно | Ссылка на регион, в котором находится URL-карта. |
| ... (rest of the table) | ... (rest of the table) |
Примечания
Примечание
- для аутентификации можно установить 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 region URL map
gcp_compute_region_url_map_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: успешно |
|
defaultService dictionary |
Полный или частичный URL ресурса defaultService, на который перенаправляется трафик, если ни одно из правил hostRules не совпадает. Если дополнительно указано defaultRouteAction, то перед отправкой запроса на бэкэнд применяются расширенные действия маршрутизации, такие как переписывание URL и т. д. Однако, если указан defaultService, defaultRouteAction не может содержать никаких weightedBackendServices. И наоборот, если routeAction указывает какие-либо weightedBackendServices, service не должен быть указан. Должно быть установлено только одно из defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService. Возвращается: успешно |
|
defaultUrlRedirect complex |
Если ни одно из указанных правил hostRules не совпадает, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если указан defaultUrlRedirect, defaultService или defaultRouteAction не должны быть установлены. Возвращается: успешно |
|
hostRedirect string |
Хост, который будет использоваться в ответе о перенаправлении вместо того, который был предоставлен в запросе. Значение должно быть от 1 до 255 символов. Возвращается: успешно |
|
httpsRedirect boolean |
Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого значения в true для TargetHttpsProxy не допускается. Значение по умолчанию установлено в false. Возвращается: успешно |
|
pathRedirect string |
Путь, который будет использоваться в ответе о перенаправлении вместо того, который был предоставлен в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Предоставьте только один или ни одного. Если ни один из них не предоставлен, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. Возвращается: успешно |
|
prefixRedirect string |
Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Предоставьте только один или ни одного. Если ни один из них не предоставлен, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов. Возвращается: успешно |
|
redirectResponseCode string |
Код состояния HTTP, который будет использоваться для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, это значение по умолчанию и соответствует 301. * FOUND, что соответствует 302. * SEE_OTHER, что соответствует 303. * TEMPORARY_REDIRECT, что соответствует 307. В этом случае метод запроса будет сохранен. * PERMANENT_REDIRECT, что соответствует 308. В этом случае метод запроса будет сохранен. Возвращается: успешно |
|
stripQuery boolean |
Если установлено в true, любая сопровождающая часть запроса исходного URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется. Возвращается: успешно |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успешно |
|
fingerprint string |
Отпечаток этого ресурса. Это поле используется внутренне во время обновления этого ресурса. Возвращается: успешно |
|
hostRules complex |
Список правил HostRules для использования с URL. Возвращается: успешно |
|
description string |
Необязательное описание этого правила HostRule. Укажите это свойство при создании ресурса. Возвращается: успешно |
|
hosts list / elements=string |
Список шаблонов хостов для сопоставления. Они должны быть допустимыми именами хостов, за исключением того, что * будет соответствовать любой строке ([a-z0-9-.]*). В этом случае * должен быть первым символом и должен следовать в шаблоне за - или . Возвращается: успешно |
|
pathMatcher string |
Имя PathMatcher, которое будет использоваться для сопоставления части пути URL, если hostRule соответствует части хоста URL. Возвращается: успешно |
|
id integer |
Уникальный идентификатор ресурса. Возвращено: success |
|
name string |
Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно состоять из 1-63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращено: success |
|
pathMatchers complex |
Список именованных PathMatchers для использования с URL. Возвращено: success |
|
defaultService dictionary |
Ссылка на ресурс RegionBackendService. Он будет использоваться, если ни одно из правил pathRules, определенных этим PathMatcher, не соответствует части пути URL. Возвращено: success |
|
defaultUrlRedirect complex |
Если ни одно из указанных правил hostRules не соответствует, запрос перенаправляется на URL, указанный в defaultUrlRedirect. Если указан defaultUrlRedirect, defaultService или defaultRouteAction не должны быть установлены. Возвращено: success |
|
hostRedirect string |
Хост, который будет использоваться в ответе на перенаправление вместо того, который был предоставлен в запросе. Значение должно быть от 1 до 255 символов. Возвращено: success |
|
httpsRedirect boolean |
Если установлено значение true, схема URL в перенаправленном запросе устанавливается в https. Если установлено значение false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого значения true для TargetHttpsProxy не допускается. Значение по умолчанию установлено в false. Возвращено: success |
|
pathRedirect string |
Путь, который будет использоваться в ответе на перенаправление вместо того, который был предоставлен в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Укажите только один или ни одного. Если ни один из них не указан, для перенаправления будет использоваться путь исходного запроса. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
prefixRedirect string |
Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Укажите только один или ни одного. Если ни один из них не указан, для перенаправления будет использоваться путь исходного запроса. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
redirectResponseCode string |
HTTP-код состояния, используемый для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, значение по умолчанию, соответствующее 301. * FOUND, что соответствует 302. * SEE_OTHER, что соответствует 303. * TEMPORARY_REDIRECT, что соответствует 307. В этом случае метод запроса будет сохранен. * PERMANENT_REDIRECT, что соответствует 308. В этом случае метод запроса будет сохранен. Возвращено: success |
|
stripQuery boolean |
Если установлено значение true, любая сопровождающая часть запроса исходного URL удаляется перед перенаправлением запроса. Если установлено значение false, часть запроса исходного URL сохраняется. Возвращено: success |
|
description string |
Необязательное описание этого ресурса. Возвращено: success |
|
name string |
Имя, по которому к этому PathMatcher обращается HostRule. Возвращено: success |
|
pathRules complex |
Список правил пути. Используйте этот список вместо routeRules, когда достаточно маршрутизации на основе простого сопоставления путей. Порядок, в котором указываются правила пути, не имеет значения. Сопоставления всегда выполняются по принципу «самый длинный путь в первую очередь». Например: правило pathRule с путем /a/b/c/* будет соответствовать перед /a/b/* независимо от порядка, в котором эти пути появляются в этом списке. Внутри данного pathMatcher должен быть установлен только один из pathRules или routeRules. Возвращено: success |
|
paths list / elements=string |
Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и единственное место, где допускается \*, находится в конце после /. Строка, подаваемая в path matcher, не включает текст после первого ? или #, и эти символы здесь не допускаются. Возвращено: success |
|
routeAction complex |
В ответ на совпадение пути, балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как переписывание URL-адресов, преобразование заголовков и т. д., перед переадресацией запроса на выбранный бэкэнд. Если routeAction указывает какие-либо weightedBackendServices, service не должен быть установлен. И наоборот, если service установлен, routeAction не может содержать какие-либо weightedBackendServices. Должно быть установлено только одно из routeAction или urlRedirect. Возвращено: success |
|
corsPolicy complex |
Спецификация для разрешения кросс-доменных запросов на стороне клиента. Пожалуйста, ознакомьтесь с рекомендацией W3C по обмену ресурсами с разных источников. Возвращено: success |
|
allowCredentials boolean |
В ответ на предварительный запрос, установка этого значения в true указывает на то, что фактический запрос может включать учетные данные пользователя. Это преобразуется в заголовок Access-Control-Allow-Credentials. По умолчанию — false. Возвращено: success |
|
allowHeaders list / elements=string |
Указывает содержимое для заголовка Access-Control-Allow-Headers. Возвращено: success |
|
allowMethods list / elements=string |
Указывает содержимое для заголовка Access-Control-Allow-Methods. Возвращено: success |
|
allowOriginRegexes list / elements=string |
Указывает шаблоны регулярных выражений, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript Источник разрешен, если он соответствует allow_origins или allow_origin_regex. Возвращено: success |
|
allowOrigins list / elements=string |
Указывает список источников, которым будет разрешено выполнять CORS-запросы. Источник разрешен, если он соответствует allow_origins или allow_origin_regex. Возвращено: success |
|
disabled boolean |
Если true, указывает, что политика CORS отключена. Возвращено: success |
|
exposeHeaders list / elements=string |
Указывает содержимое для заголовка Access-Control-Expose-Headers. Возвращено: success |
|
maxAge integer |
Указывает, как долго результаты предварительного запроса могут кэшироваться. Это преобразуется в содержимое для заголовка Access-Control-Max-Age. Возвращено: success |
|
faultInjectionPolicy complex |
Спецификация для внедрения инъекции ошибок в трафик для проверки устойчивости клиентов к отказам служб бекенда. В рамках инъекции ошибок, когда клиенты отправляют запросы в службу бекенда, задержки могут быть введены балансировщиком нагрузки для определенного процента запросов перед отправкой этих запросов в службу бекенда. Аналогично, запросы от клиентов могут быть прерваны балансировщиком нагрузки для определенного процента запросов. timeout и retry_policy будут игнорироваться клиентами, которые настроены с fault_injection_policy. Возвращено: success |
|
abort complex |
Спецификация того, как запросы клиентов прерываются как часть инъекции ошибок. Возвращено: success |
|
httpStatus integer |
Код состояния HTTP, используемый для прерывания запроса. Значение должно быть в диапазоне от 200 до 599 включительно. Возвращено: success |
|
percentage string |
Процент трафика (подключений/операций/запросов), который будет прерван в рамках инъекции ошибок. Значение должно быть в диапазоне от 0,0 до 100,0 включительно. Возвращено: success |
|
delay complex |
Спецификация того, как запросы клиентов задерживаются как часть инъекции ошибок, прежде чем быть отправленными в службу бекенда. Возвращено: success |
|
fixedDelay complex |
Указывает значение интервала фиксированной задержки. Возвращено: success |
|
nanos integer |
Промежуток времени, составляющий долю секунды с разрешением в наносекунды. Продолжительности менее одной секунды представляются с полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
percentage string |
Процент трафика (подключений/операций/запросов), на котором будет введена задержка как часть инжекции ошибок. Значение должно быть от 0,0 до 100,0 включительно. Возвращено: success |
|
requestMirrorPolicy complex |
Указывает политику того, как запросы, предназначенные для бэкендов маршрута, проецируются на отдельную зеркальную службу бэкенда. Loadbalancer не ожидает ответов от теневой службы. Перед отправкой трафика в теневую службу к заголовку host/authority добавляется суффикс -shadow. Возвращено: success |
|
backendService dictionary |
Зеркалируемый ресурс RegionBackendService. Возвращено: success |
|
retryPolicy complex |
Указывает политику повтора, связанную с этим маршрутом. Возвращено: success |
|
numRetries integer |
Указывает разрешенное количество повторов. Это число должно быть > 0. Возвращено: success |
|
perTryTimeout complex |
Указывает ненулевое время ожидания для каждой попытки повтора. Возвращено: success |
|
nanos integer |
Промежуток времени, составляющий долю секунды с разрешением в наносекунды. Продолжительности менее одной секунды представляются с полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
retryConditions list / elements=string |
Указывает одно или несколько условий, когда применяется это правило повтора. Допустимые значения: - 5xx: Loadbalancer предпримет попытку повтора, если служба бэкенда ответит с любым кодом ответа 5xx или если служба бэкенда вообще не ответит, например: разрывы соединения, сброс, тайм-аут чтения, сбой соединения и отклоненные потоки.
В настоящее время единственная поддерживаемая повторяемая ошибка — 409.
Возвращено: success |
|
timeout complex |
Указывает время ожидания для выбранного маршрута. Время ожидания вычисляется с момента полной обработки запроса (т. е. конец потока) до момента полной обработки ответа. Время ожидания включает все повторы. Если не указано, используется значение по умолчанию — 15 секунд. Возвращено: success |
|
nanos integer |
Промежуток времени, составляющий долю секунды с разрешением в наносекунды. Продолжительности менее одной секунды представляются с полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
urlRewrite complex |
Спецификация для изменения URL запроса перед переадресацией запроса на сопоставленную службу. Возвращено: success |
|
hostRewrite string |
Перед переадресацией запроса к выбранному сервису, заголовок host запроса заменяется на содержимое hostRewrite. Значение должно быть от 1 до 255 символов. Возвращено: success |
|
pathPrefixRewrite string |
Перед переадресацией запроса к выбранному сервису backend, совпадающая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
weightedBackendServices complex |
Список взвешенных служб backend, куда будет отправляться трафик при совпадении маршрута. Веса определяют долю трафика, идущего на соответствующую службу backend. Если весь трафик должен идти к одной службе backend, должен быть один weightedBackendService с весом, отличным от 0. После того, как служба backend определена и перед переадресацией запроса к службе backend, применяются расширенные действия маршрутизации, такие как переписывание URL и преобразование заголовков, в зависимости от дополнительных параметров, указанных в этом HttpRouteAction. Возвращено: success |
|
backendService dictionary |
Ресурс RegionBackendService по умолчанию. Перед переадресацией запроса к backendService, балансировщик нагрузки применяет любые соответствующие headerActions, указанные как часть этого backendServiceWeight. Возвращено: success |
|
headerAction complex |
Указывает изменения заголовков запроса и ответа, которые должны вступить в силу для выбранного backendService. headerAction, указанные здесь, вступают в силу перед headerAction в охватывающих HttpRouteRule, PathMatcher и UrlMap. Возвращено: success |
|
requestHeadersToAdd complex |
Заголовки, которые необходимо добавить к соответствующему запросу перед переадресацией запроса к backendService. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение добавляемого заголовка. Возвращено: success |
|
replace boolean |
Если false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
requestHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из запроса перед переадресацией запроса к backendService. Возвращено: success |
|
responseHeadersToAdd complex |
Заголовки для добавления в ответ перед отправкой ответа обратно клиенту. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение добавляемого заголовка. Возвращено: success |
|
replace boolean |
Если false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
responseHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из ответа перед отправкой ответа обратно клиенту. Возвращено: success |
|
weight integer |
Указывает долю трафика, отправляемого в backendService, вычисляемую как weight / (сумма всех весов weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После того, как запрос пользователя был направлен в backendService, последующие запросы будут отправлены в тот же backendService, как определено политикой аффинности сеанса BackendService. Значение должно быть в диапазоне от 0 до 1000. Возвращено: success |
|
service dictionary |
Ресурс регионального backend service, на который направляется трафик, если это правило соответствует. Если дополнительно указан routeAction, то действия расширенной маршрутизации, такие как переписывание URL и т. д., вступают в силу до отправки запроса в бэкэнд. Однако, если указан service, routeAction не может содержать никаких weightedBackendService. И наоборот, если routeAction указывает какие-либо weightedBackendServices, service не должен быть указан. Должно быть установлено только одно из urlRedirect, service или routeAction.weightedBackendService. Возвращено: success |
|
urlRedirect complex |
Когда совпадает шаблон пути, запрос перенаправляется на URL, указанный urlRedirect. Если указан urlRedirect, service или routeAction не должны быть установлены. Возвращено: success |
|
hostRedirect string |
Хост, который будет использоваться в ответе перенаправления вместо того, который был предоставлен в запросе. Значение должно быть от 1 до 255 символов. Возвращено: success |
|
httpsRedirect boolean |
Если установлено значение true, схема URL в перенаправленном запросе устанавливается в https. Если установлено значение false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого значения true для TargetHttpsProxy не допускается. Значение по умолчанию установлено как false. Возвращено: success |
|
pathRedirect string |
Путь, который будет использоваться в ответе перенаправления вместо того, который был предоставлен в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Предоставьте только один или ни одного. Если ни один из них не предоставлен, для перенаправления будет использоваться путь исходного запроса. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
prefixRedirect string |
Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Предоставьте только один или ни одного. Если ни один из них не предоставлен, для перенаправления будет использоваться путь исходного запроса. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
redirectResponseCode string |
Код состояния HTTP, который будет использоваться для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, это значение по умолчанию и соответствует 301. * FOUND, что соответствует 302. * SEE_OTHER, что соответствует 303. * TEMPORARY_REDIRECT, что соответствует 307. В этом случае метод запроса будет сохранен. * PERMANENT_REDIRECT, что соответствует 308. В этом случае метод запроса будет сохранен. Возвращено: success |
|
stripQuery boolean |
Если установлено значение true, любая сопровождающая часть запроса исходного URL-адреса удаляется перед перенаправлением запроса. Если установлено значение false, часть запроса исходного URL-адреса сохраняется. Возвращено: success |
|
routeRules complex |
Список упорядоченных правил маршрутизации HTTP. Используйте этот список вместо pathRules, когда желательны расширенное сопоставление маршрутов и действия маршрутизации. Порядок указания routeRules имеет значение: первое правило, которое соответствует, вызовет действие указанной маршрутизации. В пределах данного pathMatcher должен быть установлен только один из pathRules или routeRules. routeRules не поддерживаются в UrlMaps, предназначенных для внешних балансировщиков нагрузки. Возвращено: success |
|
headerAction complex |
Указывает изменения заголовков запроса и ответа, которые должны вступить в силу для выбранного backendService. Указанные здесь headerAction применяются до pathMatchers[].headerAction и после pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction. Возвращено: success |
|
requestHeadersToAdd complex |
Заголовки, которые необходимо добавить к соответствующему запросу перед пересылкой запроса в backendService. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение добавляемого заголовка. Возвращено: success |
|
replace boolean |
Если значение false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если значение true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
requestHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из запроса перед переадресацией запроса в backendService. Возвращено: success |
|
responseHeadersToAdd complex |
Заголовки для добавления в ответ перед отправкой ответа обратно клиенту. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение заголовка для добавления. Возвращено: success |
|
replace boolean |
Если значение false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если значение true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
responseHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из ответа перед отправкой ответа обратно клиенту. Возвращено: success |
|
matchRules complex |
Правила определения соответствия. Возвращено: success |
|
fullPathMatch string |
Для выполнения условия matchRule путь запроса должен точно совпадать со значением, указанным в fullPathMatch, после удаления любых параметров запроса и якоря, которые могут быть частью исходного URL-адреса. FullPathMatch должен содержать от 1 до 1024 символов. Можно указать только одно из значений: prefixMatch, fullPathMatch или regexMatch. Возвращено: success |
|
headerMatches complex |
Указывает список критериев соответствия заголовков, все из которых должны соответствовать соответствующим заголовкам в запросе. Возвращено: success |
|
exactMatch string |
Значение должно точно совпадать с содержимым exactMatch. Должно быть установлено только одно из значений: exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
headerName string |
Имя HTTP-заголовка для сопоставления. Для сопоставления с авторитетом HTTP-запроса используйте headerMatch с именем заголовка «:authority». Для сопоставления метода запроса используйте headerName «:method». Возвращено: success |
|
invertMatch boolean |
Если установлено значение false, headerMatch считается совпадением, если указанные выше критерии соответствия выполнены. Если установлено значение true, headerMatch считается совпадением, если указанные выше критерии соответствия НЕ выполнены. По умолчанию — false. Возвращено: success |
|
prefixMatch string |
Значение заголовка должно начинаться с содержимого prefixMatch. Должно быть установлено только одно из значений: exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
presentMatch boolean |
Заголовок с содержимым headerName должен существовать. Сопоставление происходит независимо от того, имеет ли заголовок запроса значение или нет. Должно быть установлено только одно из значений: exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
rangeMatch complex |
Значение заголовка должно быть целым числом, и его значение должно находиться в диапазоне, указанном в rangeMatch. Если заголовок не содержит целого числа, числа или пуст, сопоставление завершается неудачей. Например, для диапазона [-5, 0] * -3 будет соответствовать * 0 не будет соответствовать * 0,25 не будет соответствовать * -3someString не будет соответствовать. Должно быть установлено только одно из значений: exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
rangeEnd integer |
Конец диапазона (исключительно). Возвращено: success |
|
rangeStart integer |
Начало диапазона (включительно). Возвращено: success |
|
regexMatch string |
Значение заголовка должно соответствовать регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см.: en.cppreference.com/w/cpp/regex/ecmascript Для сопоставления с портом, указанным в HTTP-запросе, используйте headerMatch с headerName, установленным в PORT, и регулярное выражение, удовлетворяющее спецификатору порта заголовка Host RFC2616. Должно быть установлено только одно из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
suffixMatch string |
Значение заголовка должно заканчиваться содержимым suffixMatch. Должно быть установлено только одно из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch. Возвращено: success |
|
ignoreCase boolean |
Указывает, что совпадения prefixMatch и fullPathMatch чувствительны к регистру. По умолчанию — false. Возвращено: success |
|
metadataFilters complex |
Непрозрачные критерии фильтрации, используемые Loadbalancer для ограничения конфигурации маршрутизации ограниченным набором совместимых с xDS клиентов. В своих запросах xDS к Loadbalancer клиенты xDS предоставляют метаданные узла. Если происходит совпадение, соответствующая конфигурация маршрутизации становится доступной этим прокси. Для каждого metadataFilter в этом списке, если его filterMatchCriteria установлено в MATCH_ANY, по крайней мере один из filterLabels должен соответствовать соответствующей метке, указанной в метаданных. Если его filterMatchCriteria установлено в MATCH_ALL, то все его filterLabels должны соответствовать соответствующим меткам в предоставленных метаданных. metadataFilters, указанные здесь, могут переопределять те, которые указаны в ForwardingRule, который ссылается на этот UrlMap. metadataFilters применяется только к Loadbalancers, у которых loadBalancingScheme установлен в INTERNAL_SELF_MANAGED. Возвращено: success |
|
filterLabels complex |
Список пар значений меток, которые должны соответствовать меткам в предоставленных метаданных на основе filterMatchCriteria. Этот список не должен быть пустым и может содержать не более 64 записей. Возвращено: success |
|
name string |
Имя метки метаданных. Имя может иметь максимальную длину 1024 символа и должно быть не короче 1 символа. Возвращено: success |
|
value string |
Значение метки должно совпадать с указанным значением. value может иметь максимальную длину 1024 символа. Возвращено: success |
|
filterMatchCriteria string |
Указывает, как отдельные совпадения filterLabel в списке filterLabels вносят вклад в общее совпадение metadataFilter. Поддерживаемые значения: * MATCH_ANY: По крайней мере одна из filterLabels должна иметь совпадающую метку в предоставленных метаданных. * MATCH_ALL: Все filterLabels должны иметь совпадающие метки в предоставленных метаданных. Возвращено: success |
|
prefixMatch string |
Для удовлетворения условия matchRule путь запроса должен начинаться с указанного prefixMatch. prefixMatch должен начинаться с /. Значение должно быть от 1 до 1024 символов. Должно быть указано только одно из prefixMatch, fullPathMatch или regexMatch. Возвращено: success |
|
queryParameterMatches complex |
Указывает список критериев соответствия параметров запроса, все из которых должны соответствовать соответствующим параметрам запроса в запросе. Возвращено: success |
|
exactMatch string |
queryParameterMatch соответствует, если значение параметра точно соответствует содержимому exactMatch. Должно быть установлено только одно из presentMatch, exactMatch и regexMatch. Возвращено: success |
|
name string |
Имя параметра запроса для сопоставления. Параметр запроса должен существовать в запросе, в противном случае сопоставление запроса завершается неудачей. Возвращено: success |
|
presentMatch boolean |
Указывает, что queryParameterMatch соответствует, если запрос содержит параметр запроса, независимо от того, имеет ли параметр значение или нет. Должно быть установлено только одно из presentMatch, exactMatch и regexMatch. Возвращено: success |
|
regexMatch string |
Соответствие queryParameterMatch выполняется, если значение параметра соответствует регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Должно быть установлено только одно из presentMatch, exactMatch и regexMatch. Возвращено: success |
|
regexMatch string |
Для удовлетворения условию matchRule путь запроса должен соответствовать регулярному выражению, указанному в regexMatch, после удаления любых параметров запроса и якоря, предоставленного с исходным URL-адресом. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Должно быть указано только одно из prefixMatch, fullPathMatch или regexMatch. Возвращено: success |
|
priority integer |
Для routeRules в пределах данного pathMatcher приоритет определяет порядок, в котором балансировщик нагрузки будет интерпретировать routeRules. RouteRules оцениваются в порядке приоритета, от наименьшего к наибольшему числу. Приоритет правила уменьшается по мере увеличения его номера (1, 2, 3, N+1). Применяется первое правило, соответствующее запросу. Нельзя настраивать два или более routeRules с одинаковым приоритетом. Приоритет для каждого правила должен быть установлен в число от 0 до 2147483647 включительно. Номера приоритетов могут иметь пробелы, что позволяет добавлять или удалять правила в будущем, не влияя на остальные правила. Например, 1, 2, 3, 4, 5, 9, 12, 16 — это допустимая последовательность номеров приоритетов, к которой можно добавить правила с номерами от 6 до 8, от 10 до 11 и от 13 до 15 в будущем без какого-либо влияния на существующие правила. Возвращено: success |
|
routeAction complex |
В ответ на соответствующее matchRule балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как переписывание URL-адресов, преобразования заголовков и т. д., перед переадресацией запроса на выбранный бэкэнд. Если routeAction указывает какие-либо weightedBackendServices, service не должен быть установлен. И наоборот, если установлен service, routeAction не может содержать какие-либо weightedBackendServices. Должно быть установлено только одно из routeAction или urlRedirect. Возвращено: success |
|
corsPolicy complex |
Спецификация для разрешения межсайтовых запросов на стороне клиента. См. рекомендацию W3C по обмену ресурсами между разными источниками. Возвращено: success |
|
allowCredentials boolean |
В ответ на предварительный запрос установка этого значения в true указывает на то, что фактический запрос может включать учетные данные пользователя. Это преобразуется в заголовок Access-Control-Allow-Credentials. По умолчанию — false. Возвращено: success |
|
allowHeaders list / elements=string |
Указывает содержимое для заголовка Access-Control-Allow-Headers. Возвращено: success |
|
allowMethods list / elements=string |
Указывает содержимое для заголовка Access-Control-Allow-Methods. Возвращено: success |
|
allowOriginRegexes list / elements=string |
Указывает шаблоны регулярных выражений, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует allow_origins или allow_origin_regex. Возвращено: success |
|
allowOrigins list / elements=string |
Указывает список источников, которым будет разрешено выполнять CORS-запросы. Источник разрешен, если он соответствует allow_origins или allow_origin_regex. Возвращено: success |
|
disabled boolean |
Если true, указывает, что политика CORS отключена. что указывает на то, что политика CORS действует. По умолчанию — false. Возвращено: success |
|
exposeHeaders list / elements=string |
Указывает содержимое для заголовка Access-Control-Expose-Headers. Возвращено: success |
|
maxAge integer |
Указывает, как долго могут кэшироваться результаты предварительного запроса. Это преобразуется в содержимое заголовка Access-Control-Max-Age. Возвращено: success |
|
faultInjectionPolicy complex |
Спецификация для внедрения инъекции ошибок в трафик для проверки устойчивости клиентов к сбоям в службе бекенда. В рамках инъекции ошибок, когда клиенты отправляют запросы в службу бекенда, балансировщик нагрузки может вводить задержки для определенного процента запросов перед отправкой этих запросов в службу бекенда. Аналогично, балансировщик нагрузки может прерывать запросы от клиентов для определенного процента запросов. timeout и retry_policy будут игнорироваться клиентами, которые настроены с fault_injection_policy. Возвращено: success |
|
abort complex |
Спецификация того, как клиентские запросы прерываются как часть инъекции ошибок. Возвращено: success |
|
httpStatus integer |
Код состояния HTTP, используемый для прерывания запроса. Значение должно быть в диапазоне от 200 до 599 включительно. Возвращено: success |
|
percentage string |
Процент трафика (подключений/операций/запросов), который будет прерван как часть инъекции ошибок. Значение должно быть в диапазоне от 0,0 до 100,0 включительно. Возвращено: success |
|
delay complex |
Спецификация того, как клиентские запросы задерживаются как часть инъекции ошибок, прежде чем быть отправленными в бекенд-сервис. Возвращено: success |
|
fixedDelay complex |
Указывает значение интервала фиксированной задержки. Возвращено: success |
|
nanos integer |
Промежуток времени, который является частью секунды с разрешением в наносекунды. Продолжительность менее одной секунды представляется полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
percentage string |
Процент трафика (подключений/операций/запросов), на котором будет введена задержка как часть инъекции ошибок. Значение должно быть в диапазоне от 0,0 до 100,0 включительно. Возвращено: success |
|
requestMirrorPolicy complex |
Указывает политику того, как запросы, предназначенные для бекенд-сервисов маршрута, проецируются на отдельный зеркальный бекенд-сервис. Loadbalancer не ожидает ответов от теневого сервиса. Перед отправкой трафика в теневой сервис к заголовку host/authority добавляется суффикс -shadow. Возвращено: success |
|
backendService dictionary |
Зеркалируемый ресурс RegionBackendService. Возвращено: success |
|
retryPolicy complex |
Указывает политику повтора, связанную с этим маршрутом. Возвращено: success |
|
numRetries integer |
Указывает разрешенное число повторов. Это число должно быть > 0. Возвращено: success |
|
perTryTimeout complex |
Указывает ненулевое время ожидания для каждой попытки повтора. Возвращено: success |
|
nanos integer |
Промежуток времени, который является частью секунды с разрешением в наносекунды. Продолжительность менее одной секунды представляется полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
retryConditions list / elements=string |
Указывает одно или несколько условий, когда применяется это правило повтора. Допустимые значения: * 5xx: балансировщик нагрузки предпримет попытку повтора, если служба backend отвечает кодом ответа 5xx или если служба backend вообще не отвечает, например: разрывы соединения, сброс, тайм-аут чтения, сбой соединения и отклоненные потоки. * gateway-error: Аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504. * connect-failure: Балансировщик нагрузки будет повторять попытки при сбоях подключения к службам backend, например, из-за тайм-аутов соединения. * retriable-4xx: Балансировщик нагрузки будет повторять попытки для повторяемых кодов ответа 4xx. В настоящее время поддерживается только повторяемая ошибка 409. * refused-stream: Балансировщик нагрузки будет повторять попытки, если служба backend сбрасывает поток с кодом ошибки REFUSED_STREAM. Этот тип сброса указывает на то, что повторение безопасно. * cancelled: Балансировщик нагрузки будет повторять попытки, если код состояния gRPC в заголовке ответа установлен в cancelled * deadline-exceeded: Балансировщик нагрузки будет повторять попытки, если код состояния gRPC в заголовке ответа установлен в deadline-exceeded * resource-exhausted: Балансировщик нагрузки будет повторять попытки, если код состояния gRPC в заголовке ответа установлен в resource-exhausted * unavailable: Балансировщик нагрузки будет повторять попытки, если код состояния gRPC в заголовке ответа установлен в unavailable. Возвращено: success |
|
timeout complex |
Указывает тайм-аут для выбранного маршрута. Тайм-аут вычисляется с момента полной обработки запроса (т. е. end-of-stream) до момента полной обработки ответа. Тайм-аут включает все повторы. Если не указано, используется значение по умолчанию — 15 секунд. Возвращено: success |
|
nanos integer |
Промежуток времени, являющийся частью секунды с разрешением в наносекунды. Продолжительность менее одной секунды представляется полем `seconds`, равным 0, и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно. Возвращено: success |
|
seconds string |
Промежуток времени с разрешением в одну секунду. Должно быть от 0 до 315 576 000 000 включительно. Возвращено: success |
|
urlRewrite complex |
Спецификация для изменения URL запроса перед переадресацией запроса на сопоставленную службу. Возвращено: success |
|
hostRewrite string |
Перед переадресацией запроса на выбранную службу заголовок host запроса заменяется содержимым hostRewrite. Значение должно быть от 1 до 255 символов. Возвращено: success |
|
pathPrefixRewrite string |
Перед переадресацией запроса на выбранную службу backend, соответствующая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
weightedBackendServices complex |
Список взвешенных служб backend для отправки трафика при совпадении маршрута. Веса определяют долю трафика, которая поступает на соответствующую службу backend. Если весь трафик должен поступать на одну службу backend, должна быть одна weightedBackendService с весом, отличным от 0. После того, как служба backend определена и перед переадресацией запроса на службу backend, действия расширенной маршрутизации, такие как переписывание URL и преобразования заголовков, применяются в зависимости от дополнительных параметров, указанных в этом HttpRouteAction. Возвращено: success |
|
backendService dictionary |
Ресурс RegionBackendService по умолчанию. Перед переадресацией запроса на backendService балансировщик нагрузки применяет любые соответствующие headerActions, указанные как часть этого backendServiceWeight. Возвращено: success |
|
headerAction complex |
Указывает изменения заголовков запросов и ответов, которые должны вступить в силу для выбранной службы backend. headerAction, указанные здесь, вступают в силу перед headerAction в заключительных HttpRouteRule, PathMatcher и UrlMap. Возвращено: success |
|
requestHeadersToAdd complex |
Заголовки, которые нужно добавить к соответствующему запросу перед переадресацией запроса на backendService. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение добавляемого заголовка. Возвращено: success |
|
replace boolean |
Если false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
requestHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из запроса перед переадресацией запроса в backendService. Возвращено: success |
|
responseHeadersToAdd complex |
Заголовки для добавления в ответ перед отправкой ответа клиенту. Возвращено: success |
|
headerName string |
Имя заголовка. Возвращено: success |
|
headerValue string |
Значение добавляемого заголовка. Возвращено: success |
|
replace boolean |
Если false, headerValue добавляется к любым значениям, которые уже существуют для заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая любые значения, которые были установлены для этого заголовка. Возвращено: success |
|
responseHeadersToRemove list / elements=string |
Список имен заголовков, которые необходимо удалить из ответа перед отправкой ответа клиенту. Возвращено: success |
|
weight integer |
Указывает долю трафика, отправляемого в backendService, вычисляемую как weight / (сумма всех весов weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После того, как запрос пользователя был направлен в backendService, последующие запросы будут отправлены в тот же backendService, как определено политикой сродства сеансов BackendService. Значение должно быть от 0 до 1000. Возвращено: success |
|
service dictionary |
Ресурс регионального backend-сервиса, на который направляется трафик, если это правило соответствует. Если дополнительно указано routeAction, то перед отправкой запроса в бэкэнд применяются расширенные действия маршрутизации, такие как переписывание URL-адресов и т. д. Однако, если указан service, routeAction не может содержать ни одного weightedBackendService. И наоборот, если routeAction указывает какие-либо weightedBackendServices, service не должен быть указан. Должно быть установлено только одно из urlRedirect, service или routeAction.weightedBackendService. Возвращено: success |
|
urlRedirect complex |
Когда это правило соответствует, запрос перенаправляется на URL-адрес, указанный urlRedirect. Если указан urlRedirect, service или routeAction не должны быть установлены. Возвращено: success |
|
hostRedirect string |
Хост, который будет использоваться в ответе о перенаправлении вместо того, который был предоставлен в запросе. Значение должно быть от 1 до 255 символов. Возвращено: success |
|
httpsRedirect boolean |
Если установлено в true, схема URL в перенаправленном запросе устанавливается в https. Если установлено в false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого значения true для TargetHttpsProxy не допускается. Значение по умолчанию установлено в false. Возвращено: success |
|
pathRedirect string |
Путь, который будет использоваться в ответе о перенаправлении вместо того, который был предоставлен в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Предоставьте только один или ни одного. Если ни один не предоставлен, путь исходного запроса будет использоваться для перенаправления. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
prefixRedirect string |
Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL-адреса перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Предоставьте только один или ни одного. Если ни один не предоставлен, путь исходного запроса будет использоваться для перенаправления. Значение должно быть от 1 до 1024 символов. Возвращено: success |
|
redirectResponseCode string |
HTTP-код состояния, который будет использоваться для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, что является значением по умолчанию и соответствует 301. * FOUND, что соответствует 302. * SEE_OTHER, что соответствует 303. * TEMPORARY_REDIRECT, что соответствует 307. В этом случае метод запроса будет сохранен. * PERMANENT_REDIRECT, что соответствует 308. В этом случае метод запроса будет сохранен. Возвращено: success |
|
stripQuery boolean |
Если установлено в значение true, любая сопровождающая часть запроса из исходного URL-адреса удаляется перед перенаправлением запроса. Если установлено в значение false, часть запроса исходного URL-адреса сохраняется. По умолчанию значение равно false. Возвращаемое значение: success |
|
region string |
Ссылка на регион, в котором находится карта URL. Возвращаемое значение: success |
|
tests complex |
Список ожидаемых сопоставлений URL-адресов. Запросы на обновление этой карты URL будут успешными только в том случае, если все тестовые сценарии пройдут. Возвращаемое значение: success |
|
description string |
Описание этого тестового сценария. Возвращаемое значение: success |
|
host string |
Часть хоста URL-адреса. Возвращаемое значение: success |
|
path string |
Часть пути URL-адреса. Возвращаемое значение: success |
|
service dictionary |
Ссылка на ожидаемый ресурс RegionBackendService, к которому должен быть сопоставлен данный URL. Возвращаемое значение: success |
Ссылки на сборку
© 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_region_url_map_info_module.html
