Spec-Zone.ru › Ansible 2.10

google.cloud.gcp_compute_region_url_map_info – Сбор информации о GCP RegionUrlMap

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.1).

Для его установки используйте: 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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
env_type
строка
Указывает, в какой среде Ansible выполняется этот модуль.
Это значение не нужно устанавливать, если вы не знаете, что делаете.
Это только изменяет строку User Agent для любых запросов к API.
filters
список / элементы=строка
Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.
Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project
строка
Проект Google Cloud Platform, который нужно использовать.
region
строка / обязательно
Ссылка на регион, в котором находится url-карта.
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.
  • для аутентификации можно установить 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-код состояния, который будет использоваться для этого действия перенаправления. Поддерживаемые значения: * 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
успех
Уникальный идентификатор ресурса.

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

pathMatchers
complex
успех
Список именованных PathMatchers для использования с URL.

defaultService
dictionary
успех
Ссылка на ресурс RegionBackendService. Будет использоваться, если ни одно из pathRules, определённых этим PathMatcher, не соответствует пути части URL.

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-код состояния, который будет использоваться для этого действия перенаправления. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT — значение по умолчанию, соответствует 301.
* FOUND — соответствует 302.
* SEE_OTHER — соответствует 303.
* TEMPORARY_REDIRECT — соответствует 307. В этом случае метод запроса сохраняется.
* PERMANENT_REDIRECT — соответствует 308. В этом случае метод запроса сохраняется.

stripQuery
boolean
успех
Если установлено в true, любая часть запроса в исходном URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется.

description
string
успех
Необязательное описание этого ресурса.

Имя
строка
успешно
Имя, по которому этот PathMatcher ссылается на HostRule.

pathRules
сложное
успешно
Список правил путей. Используйте этот список вместо routeRules, когда требуется только сопоставление путей по простому шаблону. Порядок указания правил путей не имеет значения. Сопоставления всегда выполняются на основе пути наибольшей длины. Например: pathRule с путем /a/b/c/* будет совпадать раньше, чем /a/b/* независимо от порядка, в котором эти пути появляются в этом списке. В рамках заданного pathMatcher должен быть установлен только один из pathRules или routeRules.

пути
список / элементы=строка
успешно
Список шаблонов путей для сопоставления. Каждый должен начинаться с /, и единственное место, где разрешено использовать *, — это в конце после /. Строка, подаваемая в pathMatcher, не включает текст после первого ? или #, и эти символы здесь недопустимы.

действие_маршрута
сложное
успешно
В ответ на соответствующий путь балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как перенаправление URL, преобразование заголовков и т.д., прежде чем перенаправлять запрос к выбранному бэкенду. Если routeAction указывает какие-либо weightedBackendServices, service не должен быть установлен. И наоборот, если service установлен, routeAction не может содержать никаких weightedBackendServices. Только одно из routeAction или urlRedirect должно быть установлено.

политика_cors
сложное
успешно
Спецификация для разрешения запросов на кросс-доменные запросы со стороны клиента. Пожалуйста, ознакомьтесь с рекомендацией W3C по кросс-доменному обмену ресурсами.

разрешить_кредитные_данные
булево
успешно
В ответ на предварительный запрос, установка этого значения в true указывает, что фактический запрос может включать учетные данные пользователя. Это переводится в заголовок Access-Control-Allow-Credentials. По умолчанию false.

разрешить_заголовки
список / элементы=строка
успешно
Указывает содержимое заголовка Access-Control-Allow-Headers.

разрешить_методы
список / элементы=строка
успешно
Указывает содержимое заголовка Access-Control-Allow-Methods.

разрешить_regex_происхождения
список / элементы=строка
успешно
Указывает регулярные выражения, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Происхождение разрешается, если оно соответствует либо allow_origins, либо allow_origin_regex.

разрешить_источники
список / элементы=строка
успешно
Указывает список источников, которым разрешено выполнять запросы CORS. Происхождение разрешается, если оно соответствует либо allow_origins, либо allow_origin_regex.

выключено
булево
успешно
Если true, указывает, что политика CORS отключена.

раскрывать_заголовки
список / элементы=строка
успешно
Указывает содержимое заголовка Access-Control-Expose-Headers.

maxAge
целое число
успешно
Указывает, как долго результаты предварительного запроса могут быть кэшированы. Это отображается в содержании заголовка Access-Control-Max-Age.

политика_впрыска_ошибок
сложное
успешно
Спецификация для введения ошибок в трафик, чтобы проверить устойчивость клиентов к отказу службы бэкенда. В рамках введения ошибок, когда клиенты отправляют запросы на службу бэкенда, балансировщик нагрузки может вводить задержки для определенного процента запросов перед отправкой этих запросов на службу бэкенда. Аналогичным образом запросы от клиентов могут прерываться балансировщиком нагрузки для определенного процента запросов. timeout и retry_policy будут проигнорированы клиентами, которые настроены с fault_injection_policy.

прервать
сложное
успешно
Спецификация того, как запросы клиентов прерываются в рамках введения ошибок.

httpStatus
целое число
успешно
Код HTTP-статуса, используемый для прерывания запроса. Значение должно быть включительно от 200 до 599.

процент
строка
успешно
Процент трафика (соединений/операций/запросов), который будет прерван в рамках введения ошибок. Значение должно быть включительно от 0.0 до 100.0.

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

fixedDelay
сложное
успешно
Указывает значение интервала фиксированной задержки.

наносекунды
целое число
успешно
Промежуток времени, который является дробью секунды с разрешением в наносекунды. Продолжительность менее одной секунды представлена нулевым полем «секунды» и положительным полем «наносекунды». Должно быть от 0 до 999 999 999 включительно.

секунды
строка
успешно
Промежуток времени с разрешением в секунду. Должно быть от 0 до 315 576 000 000 включительно.

процент
строка
успешно
Процент трафика (соединений/операций/запросов), для которого будет введена задержка в рамках введения ошибок. Значение должно быть включительно от 0.0 до 100.0.

политика_зеркалирования_запросов
сложное
успешно
Указывает политику того, как запросы, предназначенные для бэкендов маршрута, дублируются на отдельной зеркальной службе бэкенда. Балансировщик нагрузки не ожидает ответов от службы-зеркала. Перед отправкой трафика на службу-зеркало к хост/авторитет заголовку добавляется приставка -shadow.

служба_бэкенда
словарь
успешно
Ресурс RegionBackendService, который будет зеркально отображен.

retryPolicy
complex
success
Указывает политику повторных попыток, связанную с этим маршрутом.

numRetries
integer
success
Указывает разрешенное количество попыток повтора. Это число должно быть > 0.

perTryTimeout
complex
success
Указывает ненулевой тайм-аут на каждую попытку повтора.

nanos
integer
success
Продолжительность, которая является дробной частью секунды с разрешением в наносекунды. Продолжительности, меньшие одной секунды, представлены полем `seconds` со значением 0 и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно.

seconds
string
success
Продолжительность с разрешением в секунды. Должно быть от 0 до 315 576 000 000 включительно.

retryConditions
list / elements=string
success
Указывает один или несколько условий, когда применяется это правило повторной попытки. Допустимые значения:
- 5xx: Loadbalancer предпримет повторную попытку, если служба бэкенда ответит любым кодом ответа 5xx или вообще не ответит, например, при отключении, сбросе, тайм-ауте чтения, сбое соединения и отказе потоков.
- gateway-error: Аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504.
- connect-failure: Loadbalancer предпримет повторную попытку при сбоях подключения к службам бэкенда, например, из-за тайм-аутов подключения.
- retriable-4xx: Loadbalancer предпримет повторную попытку для исправленных кодов ответа 4xx.
В настоящее время поддерживается только одна исправленная ошибка 409.
- refused-stream: Loadbalancer предпримет повторную попытку, если служба бэкенда сбросит поток с кодом ошибки REFUSED_STREAM. Этот тип сброса указывает, что повторная попытка безопасна.
- cancelled: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в cancelled - deadline-exceeded: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в deadline-exceeded - resource-exhausted: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в resource-exhausted - unavailable: Loadbalancer предпримет повторную попытку, если код состояния gRPC в заголовке ответа установлен в unavailable.

timeout
complex
success
Указывает тайм-аут для выбранного маршрута. Тайм-аут вычисляется с момента полного обработки запроса (т. е. конца потока) до момента полной обработки ответа. Тайм-аут включает все повторные попытки. Если не указано, значение по умолчанию составляет 15 секунд.

nanos
integer
success
Продолжительность, которая является дробной частью секунды с разрешением в наносекунды. Продолжительности, меньшие одной секунды, представлены полем `seconds` со значением 0 и положительным полем `nanos`. Должно быть от 0 до 999 999 999 включительно.

seconds
string
success
Продолжительность с разрешением в секунды. Должно быть от 0 до 315 576 000 000 включительно.

urlRewrite
complex
success
Спецификация для изменения URL запроса перед переадресацией запроса на сопоставленную службу.

hostRewrite
string
success
Перед переадресацией запроса на выбранную службу заголовок хоста запроса заменяется содержимым hostRewrite. Значение должно быть от 1 до 255 символов.

pathPrefixRewrite
string
success
Перед переадресацией запроса на выбранную службу бэкенда соответствующая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть от 1 до 1024 символов.

weightedBackendServices
complex
success
Список взвешенных служб бэкенда, которым нужно отправлять трафик при совпадении маршрута. Веса определяют долю трафика, направляемого на соответствующую службу бэкенда. Если весь трафик должен идти на одну службу бэкенда, должна быть одна weightedBackendService с весом, отличным от 0. После определения службы бэкенда и перед переадресацией запроса на службу бэкенда применяются расширенные действия маршрутизации, такие как переписывание URL и преобразование заголовков, в зависимости от дополнительных параметров, указанных в этом HttpRouteAction.

backendService
dictionary
success
Ресурс RegionBackendService по умолчанию. Перед переадресацией запроса на backendService балансировщик приложений применяет все соответствующие действия с заголовками, указанные в рамках этого backendServiceWeight.

headerAction
complex
success
Указывает изменения в заголовках запросов и ответов, которые должны вступить в силу для выбранной службы бэкенда. headerAction, указанные здесь, действуют до headerAction в охватывающей HttpRouteRule, PathMatcher и UrlMap.

requestHeadersToAdd
complex
success
Заголовки, которые нужно добавить в соответствующий запрос перед переадресацией запроса на backendService.

headerName
string
success
Имя заголовка.

headerValue
string
success
Значение добавляемого заголовка.

replace
boolean
success
Если false, headerValue добавляется к уже существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя любые ранее установленные значения этого заголовка.

requestHeadersToRemove
list / elements=string
success
Список имен заголовков, которые нужно удалить из запроса перед переадресацией запроса на backendService.

responseHeadersToAdd
complex
success
Заголовки, которые нужно добавить в ответ перед отправкой ответа клиенту.

headerName
string
success
Имя заголовка.

headerValue
string
success
Значение заголовка для добавления.

replace
boolean
success
Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения.

responseHeadersToRemove
list / elements=string
success
Список имён заголовков, которые нужно удалить из ответа перед его отправкой клиенту.

weight
integer
success
Указывает долю трафика, отправляемого в backendService, вычисляемую как weight / (сумма весов всех weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После того, как запрос пользователя был перенаправлен в backendService, последующие запросы будут отправлены в тот же backendService, как определено политикой affinity сессии BackendService.
Значение должно быть между 0 и 1000.

service
dictionary
success
Ресурс backend service в регионе, которому направляется трафик, если это правило соответствует. Если routeAction также указан, применяются дополнительные действия маршрутизации, такие как перенаправление URL и т. д., перед отправкой запроса в backend. Однако, если service указан, routeAction не может содержать weightedBackendService. И наоборот, если routeAction указывает weightedBackendServices, service не должен быть указан. Только один из urlRedirect, service или routeAction.weightedBackendService должен быть задан.

urlRedirect
complex
success
При соответствии шаблону пути запрос перенаправляется на URL, указанный в urlRedirect. Если urlRedirect указан, service или routeAction не должны быть заданы.

hostRedirect
string
success
Хост, который будет использоваться в ответе с перенаправлением вместо того, который был предоставлен в запросе. Значение должно быть между 1 и 255 символами.

httpsRedirect
boolean
success
Если установлено в true, схема URL в перенаправленном запросе устанавливается в https.
Если установлено в false, схема URL перенаправленного запроса останется такой же, как и в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка в true для TargetHttpsProxy запрещена. По умолчанию установлено в false.

pathRedirect
string
success
Путь, который будет использоваться в ответе с перенаправлением вместо пути, предоставленного в запросе. pathRedirect не может быть предоставлен вместе с prefixRedirect. Используйте либо тот, либо другой, или ни того, ни другого. Если ни тот, ни другой не предоставлены, путь исходного запроса будет использован для перенаправления.
Значение должно быть между 1 и 1024 символами.

prefixRedirect
string
success
Префикс, который заменяет префиксMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть предоставлен вместе с pathRedirect. Используйте либо тот, либо другой, или ни того, ни другого. Если ни тот, ни другой не предоставлены, путь исходного запроса будет использован для перенаправления. Значение должно быть между 1 и 1024 символами.

redirectResponseCode
string
success
HTTP код состояния, используемый для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT (по умолчанию), соответствующий 301.
* FOUND, соответствующий 302.
* SEE_OTHER, соответствующий 303.
* TEMPORARY_REDIRECT, соответствующий 307. В этом случае метод запроса сохраняется.
* PERMANENT_REDIRECT, соответствующий 308. В этом случае метод запроса сохраняется.

stripQuery
boolean
success
Если установлено в true, любая сопровождающая часть запроса исходного URL удаляется перед перенаправлением запроса. Если установлено в false, часть запроса исходного URL сохраняется.

routeRules
complex
success
Список упорядоченных правил маршрутизации HTTP. Используйте этот список вместо pathRules, когда требуется продвинутое сопоставление маршрутов и действия маршрутизации. Порядок указания routeRules имеет значение: первое совпавшее правило вызовет действие маршрутизации. В рамках pathMatcher должен быть задан только один из pathRules или routeRules. routeRules не поддерживаются в UrlMaps, предназначенных для внешних балансировщиков нагрузки.

headerAction
complex
success
Указывает изменения в заголовках запроса и ответа, которые должны быть применены для выбранного backendService. headerAction, указанные здесь, применяются перед matching pathMatchers[].headerAction и после pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction.

requestHeadersToAdd
complex
success
Заголовки, которые нужно добавить в соответствующий запрос перед пересылкой его в backendService.

headerName
string
success
Имя заголовка.

headerValue
string
success
Значение заголовка для добавления.

replace
boolean
success
Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения.

requestHeadersToRemove
list / elements=string
success
Список имён заголовков, которые нужно удалить из запроса перед пересылкой его в backendService.

responseHeadersToAdd
complex
success
Заголовки, которые нужно добавить в ответ перед отправкой его клиенту.

headerName
string
success
Имя заголовка.

headerValue
string
success
Значение заголовка для добавления.

replace
boolean
success
Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, удаляя предыдущие значения.

responseHeadersToRemove
list / elements=string
success
Список имён заголовков, которые нужно удалить из ответа перед отправкой клиенту.

matchRules
complex
success
Правила определения совпадения.

fullPathMatch
string
success
Для удовлетворения условия matchRule, путь запроса должен точно совпадать со значением, указанным в fullPathMatch, после удаления любых параметров запроса и якоря, которые могут быть частью исходного URL. FullPathMatch должен быть от 1 до 1024 символов. Должен быть указан только один из prefixMatch, fullPathMatch или regexMatch.

headerMatches
complex
success
Указывает список критериев соответствия заголовков, все из которых должны соответствовать соответствующим заголовкам в запросе.

exactMatch
string
success
Значение должно точно совпадать с содержимым exactMatch. Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

headerName
string
success
Имя HTTP-заголовка для сопоставления. Для сопоставления с авторитетом HTTP-запроса используйте headerMatch со значением headerName ":authority". Для сопоставления метода запроса используйте headerName ":method".

invertMatch
boolean
success
Если установлено в false, headerMatch считается совпадением, если вышеуказанные критерии соответствия выполнены. Если установлено в true, headerMatch считается совпадением, если вышеуказанные критерии соответствия НЕ выполнены. По умолчанию false.

prefixMatch
string
success
Значение заголовка должно начинаться с содержимого prefixMatch. Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

presentMatch
boolean
success
Заголовок с содержимым headerName должен существовать. Сопоставление происходит независимо от того, имеет ли заголовок запроса значение или нет. Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

rangeMatch
complex
success
Значение заголовка должно быть целым числом и должно находиться в указанном диапазоне в rangeMatch. Если заголовок не содержит целого числа, числа или пустой, совпадение не происходит. Например, для диапазона [-5, 0] - -3 будет соответствовать. - 0 не будет соответствовать. - 0,25 не будет соответствовать. - -3someString не будет соответствовать. Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

rangeEnd
integer
success
Конец диапазона (исключительно).

rangeStart
integer
success
Начало диапазона (включительно).

regexMatch
string
success
Значение заголовка должно соответствовать регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см.: en.cppreference.com/w/cpp/regex/ecmascript Для сопоставления с портом, указанным в HTTP-запросе, используйте headerMatch со значением headerName, установленным в PORT, и регулярное выражение, удовлетворяющее спецификатору порта заголовка Host RFC2616.
Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

suffixMatch
string
success
Значение заголовка должно заканчиваться содержимым suffixMatch. Должен быть указан только один из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

ignoreCase
boolean
success
Указывает, что соответствия prefixMatch и fullPathMatch чувствительны к регистру.
По умолчанию false.

metadataFilters
complex
success
Непрозрачные критерии фильтрации, используемые Loadbalancer для ограничения конфигурации маршрутизации ограниченным набором клиентов, совместимых с xDS. В своих запросах xDS к Loadbalancer клиенты xDS предоставляют метаданные узла. Если совпадение происходит, соответствующая конфигурация маршрутизации становится доступной для этих прокси. Для каждого metadataFilter в этом списке, если его filterMatchCriteria установлено в MATCH_ANY, по крайней мере, одна из filterLabels должна соответствовать соответствующей метке, предоставленной в метаданных. Если его filterMatchCriteria установлено в MATCH_ALL, то все его filterLabels должны соответствовать соответствующим меткам в предоставленных метаданных. metadataFilters, указанные здесь, могут быть переопределены теми, которые указаны в ForwardingRule, которые ссылаются на этот UrlMap. metadataFilters применяются только к Loadbalancer, у которых loadBalancingScheme установлено в INTERNAL_SELF_MANAGED.

filterLabels
complex
success
Список пар значений меток, которые должны соответствовать меткам в предоставленных метаданных на основе filterMatchCriteria. Этот список не должен быть пустым и может содержать не более 64 элементов.

name
string
success
Имя метки метаданных. Имя может иметь максимальную длину 1024 символа и должно содержать не менее 1 символа.

value
string
success
Значение метки должно соответствовать указанному значению. значение может иметь максимальную длину 1024 символа.

filterMatchCriteria
string
success
Указывает, как соответствия отдельных filterLabel в списке filterLabels вносят вклад в общее соответствие metadataFilter. Поддерживаемые значения: - MATCH_ANY: По крайней мере, одна из filterLabels должна иметь соответствующую метку в предоставленных метаданных.
- MATCH_ALL: Все filterLabels должны иметь соответствующие метки в предоставленных метаданных.

prefixMatch
string
success
Для удовлетворения условия matchRule, путь запроса должен начинаться с указанного prefixMatch. prefixMatch должен начинаться с /. Значение должно быть от 1 до 1024 символов. Должен быть указан только один из prefixMatch, fullPathMatch или regexMatch.

queryParameterMatches
complex
success
Указывает список критериев соответствия параметрам запроса, все из которых должны соответствовать соответствующим параметрам запроса в запросе.

exactMatch
string
success
Совпадение по параметру происходит, если значение параметра точно совпадает с содержимым exactMatch. Только одно из presentMatch, exactMatch и regexMatch должно быть задано.

name
string
success
Имя параметра запроса для сопоставления. Параметр запроса должен существовать в запросе, в противном случае сопоставление запроса завершится неудачей.

presentMatch
boolean
success
Указывает, что сопоставление queryParameterMatch происходит, если запрос содержит параметр запроса, независимо от того, имеет ли параметр значение или нет. Только одно из presentMatch, exactMatch и regexMatch должно быть задано.

regexMatch
string
success
Совпадение queryParameterMatch происходит, если значение параметра соответствует регулярному выражению, указанному в regexMatch. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Только одно из presentMatch, exactMatch и regexMatch должно быть задано.

regexMatch
string
success
Для выполнения условия matchRule путь запроса должен удовлетворять регулярному выражению, указанному в regexMatch, после удаления любых параметров запроса и якорей, предоставленных в исходном URL. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Только одно из prefixMatch, fullPathMatch или regexMatch должно быть указано.

priority
integer
success
Для правил маршрутизации (routeRules) в заданном pathMatcher приоритет определяет порядок интерпретации routeRules балансировщиком нагрузки. Правила маршрутизации оцениваются в порядке приоритета, от меньшего к большему числу. Приоритет правила уменьшается по мере увеличения его номера (1, 2, 3, N+1). Применяется первое правило, которое соответствует запросу.
Вы не можете настроить два или более routeRules с одинаковым приоритетом.
Приоритет каждого правила должен быть задан числом от 0 до 2147483647 включительно.
Номера приоритетов могут иметь пробелы, что позволяет добавлять или удалять правила в будущем без влияния на остальные правила. Например, 1, 2, 3, 4, 5, 9, 12, 16 — это допустимый ряд номеров приоритетов, в который вы можете добавить правила с номерами от 6 до 8, от 10 до 11 и от 13 до 15 в будущем без влияния на существующие правила.

routeAction
complex
success
В ответ на совпадение matchRule балансировщик нагрузки выполняет расширенные действия по маршрутизации, такие как переписывание URL, преобразование заголовков и т. д., прежде чем пересылать запрос выбранному бэкенду. Если routeAction указывает какие-либо weightedBackendServices, service не должно быть установлено. И наоборот, если service установлено, routeAction не может содержать weightedBackendServices. Только одно из routeAction или urlRedirect должно быть установлено.

corsPolicy
complex
success
Спецификация для разрешения кросс-доменных запросов со стороны клиента. См. рекомендацию W3C для совместного использования ресурсов из разных доменов.

allowCredentials
boolean
success
В ответ на запрос preflight, установка этого значения в true указывает, что фактический запрос может включать учетные данные пользователя. Это отражается в заголовке Access-Control-Allow-Credentials. По умолчанию значение равно false.

allowHeaders
list / elements=string
success
Указывает содержимое заголовка Access-Control-Allow-Headers.

allowMethods
list / elements=string
success
Указывает содержимое заголовка Access-Control-Allow-Methods.

allowOriginRegexes
list / elements=string
success
Указывает шаблоны регулярных выражений, которые соответствуют разрешенным источникам. Для грамматики регулярных выражений см. en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex.

allowOrigins
list / elements=string
success
Указывает список источников, которым разрешено выполнять запросы CORS. Источник разрешен, если он соответствует либо allow_origins, либо allow_origin_regex.

disabled
boolean
success
Если true, указывает, что политика CORS отключена.
что указывает на то, что политика CORS в действии. По умолчанию значение равно false.

exposeHeaders
list / elements=string
success
Указывает содержимое заголовка Access-Control-Expose-Headers.

maxAge
integer
success
Указывает, как долго результаты запроса preflight могут быть кэшированы. Это отражается в содержимом заголовка Access-Control-Max-Age.

faultInjectionPolicy
complex
success
Спецификация для введения сбоев в трафик для проверки устойчивости клиентов к отказам бэкенд-служб. В рамках введения сбоев, когда клиенты отправляют запросы на бэкенд-службу, балансировщик нагрузки может вводить задержки для определенного процента запросов перед отправкой этих запросов на бэкенд-службу. Аналогично, балансировщик нагрузки может прерывать запросы от клиентов для определенного процента запросов. timeout и retry_policy будут проигнорированы клиентами, настроенными с fault_injection_policy.

abort
complex
success
Спецификация того, как прерываются запросы клиентов в рамках введения сбоев.

httpStatus
integer
success
Код HTTP-статуса, используемый для прерывания запроса. Значение должно быть от 200 до 599 включительно.

percentage
string
success
Процент трафика (соединений/операций/запросов), который будет прерван в рамках введения сбоев. Значение должно быть от 0,0 до 100,0 включительно.

delay
complex
success
Спецификация того, как задерживаются запросы клиентов в рамках введения сбоев, перед отправкой их на бэкенд-службу.

fixedDelay
complex
success
Указывает значение интервала фиксированной задержки.

nanos
целое число
success
Промежуток времени, представляющий дробную часть секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением 0 в поле `seconds` и положительным значением в поле `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно.

seconds
строка
success
Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно.

percentage
строка
success
Процент трафика (соединений/операций/запросов), на который будет введено замедление в рамках введения сбоя. Значение должно быть в диапазоне от 0,0 до 100,0 включительно.

requestMirrorPolicy
сложный тип
success
Определяет политику того, как запросы, предназначенные для бэкендов маршрута, будут дублироваться в отдельной зеркальной службе бэкенда. Loadbalancer не ждет ответов от зеркальной службы. Перед отправкой трафика в зеркальную службу к заголовку хоста/авторитета добавляется суффикс -shadow.

backendService
словарь
success
Ресурс RegionBackendService, который зеркально отображается.

retryPolicy
сложный тип
success
Определяет политику повторных попыток, связанную с этим маршрутом.

numRetries
целое число
success
Определяет разрешенное количество повторных попыток. Это число должно быть > 0.

perTryTimeout
сложный тип
success
Определяет ненулевой таймаут на каждую попытку повторной попытки.

nanos
целое число
success
Промежуток времени, представляющий дробную часть секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением 0 в поле `seconds` и положительным значением в поле `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно.

seconds
строка
success
Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно.

retryConditions
список / элементы=строка
success
Указывает один или несколько условий, когда применяется это правило повторных попыток. Допустимые значения:
- 5xx: Loadbalancer попытается повторить попытку, если бэкенд-сервис ответит любым кодом ответа 5xx или вообще не ответит, например, отключится, прервётся, истечёт время ожидания чтения, произойдёт сбой соединения и будет отказано в потоках.
- gateway-error: Аналогично 5xx, но применяется только к кодам ответов 502, 503 или 504.
- connect-failure: Loadbalancer повторит попытку при сбоях подключения к бэкенд-сервисам, например, из-за превышения времени ожидания подключения.
- retriable-4xx: Loadbalancer повторит попытку для исправленных кодов ответов 4xx.
В настоящее время поддерживается только одна исправляемая ошибка 409.
- refused-stream: Loadbalancer повторит попытку, если бэкенд-сервис перезапустит поток с кодом ошибки REFUSED_STREAM. Этот тип перезапуска указывает, что повторение попытки безопасно.
- cancelled: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен на cancelled.
- deadline-exceeded: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен на deadline-exceeded.
- resource-exhausted: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен на resource-exhausted.
- unavailable: Loadbalancer повторит попытку, если код состояния gRPC в заголовке ответа установлен на unavailable.

timeout
сложный тип
success
Указывает таймаут для выбранного маршрута. Таймаут вычисляется с момента полного обработки запроса (т. е. конца потока) до момента полной обработки ответа. Таймаут включает все повторные попытки. Если не указано, значение по умолчанию составляет 15 секунд.

nanos
целое число
success
Промежуток времени, представляющий дробную часть секунды с разрешением в наносекунды. Продолжительности менее одной секунды представлены значением 0 в поле `seconds` и положительным значением в поле `nanos`. Должно быть в диапазоне от 0 до 999 999 999 включительно.

seconds
строка
success
Промежуток времени с разрешением в секунды. Должно быть в диапазоне от 0 до 315 576 000 000 включительно.

urlRewrite
сложный тип
success
Спецификация для изменения URL запроса перед перенаправлением запроса на сопоставленный сервис.

hostRewrite
строка
success
Перед перенаправлением запроса на выбранный сервис заголовок хоста запроса заменяется содержимым hostRewrite. Значение должно быть в диапазоне от 1 до 255 символов.

pathPrefixRewrite
строка
success
Перед перенаправлением запроса на выбранный бэкенд-сервис соответствующая часть пути запроса заменяется на pathPrefixRewrite. Значение должно быть в диапазоне от 1 до 1024 символов.

weightedBackendServices
сложный тип
success
Список взвешенных бэкенд-сервисов, которым отправляется трафик при совпадении маршрута. Веса определяют долю трафика, который проходит к соответствующему бэкенд-сервису. Если весь трафик должен направляться на один бэкенд-сервис, должен быть один weightedBackendService с весом, установленным на ненулевое значение. После идентификации бэкенд-сервиса и перед перенаправлением запроса на бэкенд-сервис применяются расширенные действия маршрутизации, такие как переписывание URL и преобразование заголовков, в зависимости от дополнительных настроек, указанных в этом HttpRouteAction.

backendService
словарь
success
Ресурс RegionBackendService по умолчанию. Перед пересылкой запроса на backendService балансировщик применит все соответствующие действия с заголовками, указанные как часть этого backendServiceWeight.

headerAction
сложный тип
success
Указывает изменения в заголовках запроса и ответа, которые должны быть применены для выбранного backendService. headerAction, указанные здесь, применяются до headerAction в охватывающих HttpRouteRule, PathMatcher и UrlMap.

requestHeadersToAdd
сложный тип
success
Заголовки для добавления к соответствующему запросу перед перенаправлением запроса на backendService.

headerName
строка
success
Имя заголовка.

headerValue
string
success
Значение добавляемого заголовка.

replace
boolean
success
Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая предыдущие значения.

requestHeadersToRemove
list / elements=string
success
Список имён заголовков, которые нужно удалить из запроса перед отправкой в backendService.

responseHeadersToAdd
complex
success
Заголовки, которые нужно добавить в ответ перед отправкой клиенту.

headerName
string
success
Имя заголовка.

headerValue
string
success
Значение добавляемого заголовка.

replace
boolean
success
Если false, headerValue добавляется к существующим значениям заголовка. Если true, headerValue устанавливается для заголовка, отбрасывая предыдущие значения.

responseHeadersToRemove
list / elements=string
success
Список имён заголовков, которые нужно удалить из ответа перед отправкой клиенту.

weight
integer
success
Определяет долю трафика, направляемого в backendService, вычисляется как weight / (сумма весов всех weightedBackendService в routeAction). Выбор backend service определяется только для нового трафика. После направления запроса пользователя в backendService последующие запросы будут направлены в тот же backendService, как определено политикой affinity backendService.
Значение должно быть между 0 и 1000.

service
dictionary
success
Ресурс backend service в регионе, в который будет направлен трафик, если правило совпадет. Если дополнительно указан routeAction, выполняются продвинутые действия маршрутизации, такие как URL Rewrites и т.д., прежде чем запрос будет отправлен в backend. Однако, если указан service, routeAction не может содержать weightedBackendService. И наоборот, если routeAction содержит weightedBackendServices, service не должен быть указан. Должно быть указано только одно из urlRedirect, service или routeAction.weightedBackendService.

urlRedirect
complex
success
При совпадении этого правила запрос перенаправляется на URL, указанный в urlRedirect. Если указан urlRedirect, service или routeAction не должны быть указаны.

hostRedirect
string
success
Хост, который будет использован в ответе перенаправления вместо хоста, предоставленного в запросе. Значение должно быть от 1 до 255 символов.

httpsRedirect
boolean
success
Если установлено в true, схема URL в перенаправленном запросе устанавливается в https.
Если установлено в false, схема URL перенаправленного запроса останется такой же, как в запросе. Это должно быть установлено только для UrlMaps, используемых в TargetHttpProxys. Установка этого в true для TargetHttpsProxy запрещена. По умолчанию установлено в false.

pathRedirect
string
success
Путь, который будет использован в ответе перенаправления вместо пути, предоставленного в запросе. pathRedirect не может быть указан вместе с prefixRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использован для перенаправления.
Значение должно быть от 1 до 1024 символов.

prefixRedirect
string
success
Префикс, который заменяет префиксMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса. prefixRedirect не может быть указан вместе с pathRedirect. Укажите один или ни одного. Если ни один не указан, путь исходного запроса будет использован для перенаправления. Значение должно быть от 1 до 1024 символов.

redirectResponseCode
string
success
Код HTTP-статуса для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, по умолчанию, соответствует 301.
* FOUND, соответствует 302.
* SEE_OTHER, соответствует 303.
* TEMPORARY_REDIRECT, соответствует 307. В этом случае метод запроса сохранится.
* PERMANENT_REDIRECT, соответствует 308. В этом случае метод запроса сохранится.

stripQuery
boolean
success
Если установлено в true, любая часть запроса в исходном URL удаляется перед перенаправлением. Если false, часть запроса сохраняется. По умолчанию false.

region
string
success
Ссылка на регион, в котором находится url map.

tests
complex
success
Список ожидаемых сопоставлений URL. Запросы на обновление UrlMap будут успешны только если пройдут все тестовые случаи.

description
string
success
Описание тестового случая.

host
string
success
Часть хоста URL.

path
string
success
Часть пути URL.

service
dictionary
success
Ссылка на ожидаемый RegionBackendService ресурс, к которому должен быть сопоставлен данный URL.



Авторы

  • Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_region_url_map_info_module.html

Spec-Zone.ru

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