модуль google.cloud.gcp_compute_url_map_info – Сбор сведений для GCP UrlMap

access_token

string

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

auth_kind

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

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

Варианты:

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

env_type

string

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

Не задавайте этот параметр, если не знаете, что делаете.

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

filters

list / elements=string

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

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

project

string

Проект Google Cloud Platform, который следует использовать.

scopes

list / elements=string

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

resources

complex

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

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

creationTimestamp

string

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

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

defaultRouteAction

complex

Действие defaultRouteAction применяется, если ни одно из правил hostRules не совпадает. Перед пересылкой запроса выбранному бэкенду балансировщик нагрузки выполняет расширенные действия маршрутизации, например перезапись URL, преобразование заголовков и т. д.

Если в defaultRouteAction указаны какие-либо weightedBackendServices, параметр defaultService не должен быть задан. И наоборот, если задан defaultService, defaultRouteAction не может содержать weightedBackendServices.

Должен быть задан только один из параметров: defaultRouteAction или defaultUrlRedirect.

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

corsPolicy

complex

Параметры разрешения междоменных запросов со стороны клиента. См. [Рекомендацию W3C по обмену ресурсами между источниками](https://www.w3.org/TR/cors/).

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

allowCredentials

boolean

В ответ на предварительный запрос значение true означает, что фактический запрос может содержать учетные данные пользователя.

Это соответствует заголовку Access-Control-Allow-Credentials.

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

allowHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Headers.

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

allowMethods

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Methods.

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

allowOriginRegexes

list / elements=string

Задает шаблоны регулярных выражений, соответствующие разрешенным источникам. Синтаксис регулярных выражений см. на странице en.cppreference.com/w/cpp/regex/ecmascript. Источник считается разрешенным, если он соответствует элементу в allowOrigins или элементу в allowOriginRegexes.

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

allowOrigins

list / elements=string

Задает список источников, которым разрешено выполнять запросы CORS.

Источник считается разрешенным, если он соответствует элементу в allowOrigins или элементу в allowOriginRegexes.

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

disabled

boolean

Если значение равно true, политика CORS отключена. Значение по умолчанию — false, что означает, что политика CORS действует.

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

exposeHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Expose-Headers.

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

maxAge

integer

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

Это соответствует заголовку Access-Control-Max-Age.

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

faultInjectionPolicy

complex

Параметры внедрения ошибок в трафик для проверки устойчивости клиентов к сбоям службы бэкенда.

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

Клиенты, настроенные с помощью faultInjectionPolicy, не учитывают timeout и retryPolicy.

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

abort

complex

Параметры прерывания запросов клиента в рамках внедрения ошибок.

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

httpStatus

integer

Код состояния HTTP, используемый для прерывания запроса.

Значение должно быть в диапазоне от 200 до 599 включительно.

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

percentage

string

Процент трафика (соединений/операций/запросов), который будет прерван в рамках внедрения ошибок.

Значение должно быть в диапазоне от 0.0 до 100.0 включительно.

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

delay

complex

Параметры задержки запросов клиентов в рамках внедрения ошибок перед их отправкой службе бэкенда.

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

fixedDelay

complex

Задает значение фиксированного интервала задержки.

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычислены следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

percentage

string

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

Значение должно быть в диапазоне от 0.0 до 100.0 включительно.

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

requestMirrorPolicy

complex

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

Балансировщик нагрузки не ожидает ответов от зеркальной службы. Перед отправкой трафика зеркальной службе к заголовку host / authority добавляется суффикс -shadow.

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

backendService

dictionary

Полный или частичный URL ресурса BackendService, в который выполняется зеркалирование.

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

retryPolicy

complex

Задает политику повторных попыток для этого маршрута.

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

numRetries

integer

Задает допустимое количество повторных попыток. Это число должно быть > 0. Если параметр не задан, используется значение 1.

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

perTryTimeout

complex

Задает ненулевое время ожидания для каждой попытки повтора.

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

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычислены следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

retryConditions

list / elements=string

Задает одно или несколько условий применения этого правила повторных попыток. Допустимые значения: * 5xx: балансировщик нагрузки повторит попытку, если служба бэкенда ответит любым кодом 5xx или вообще не ответит, например из-за разрыва соединения, сброса, тайм-аута чтения, * сбоя подключения или отклонения потоков.

* gateway-error: аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504.

* connect-failure: балансировщик нагрузки повторит попытку при сбоях подключения к службам бэкенда, например из-за тайм-аутов подключения.

* retriable-4xx: балансировщик нагрузки повторит попытку при кодах ответа 4xx, для которых разрешены повторы.

В настоящее время поддерживается повтор только для ошибки 409.

* refused-stream: балансировщик нагрузки повторит попытку, если служба бэкенда сбросит поток с кодом ошибки REFUSED_STREAM.

Этот тип сброса указывает, что повторная попытка безопасна.

* cancelled: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC cancelled * deadline-exceeded: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC deadline-exceeded * resource-exhausted: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC resource-exhausted * unavailable: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC unavailable.

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

timeout

complex

Задает время ожидания для выбранного маршрута. Оно отсчитывается с момента полной обработки запроса (то есть получения конца потока) до момента полной обработки ответа. Время ожидания включает все повторные попытки.

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

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычислены следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

urlRewrite

complex

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

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

hostRewrite

string

Перед пересылкой запроса выбранной службе заголовок host запроса заменяется содержимым hostRewrite.

Длина значения должна составлять от 1 до 255 символов.

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

pathPrefixRewrite

string

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

Длина значения должна составлять от 1 до 1024 символов.

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

weightedBackendServices

complex

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

Веса определяют долю трафика, направляемую соответствующей службе бэкенда.

Если весь трафик должен направляться одной службе бэкенда, необходимо указать одну weightedBackendService с ненулевым значением weight.

После выбора backendService и перед пересылкой запроса службе бэкенда выполняются расширенные действия маршрутизации, например перезапись URL и преобразование заголовков, в соответствии с дополнительными настройками, заданными в этом HttpRouteAction.

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

backendService

dictionary

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

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

headerAction

complex

Задает изменения заголовков запросов и ответов, применяемые к выбранному backendService.

Указанные здесь headerAction применяются до headerAction во внешних HttpRouteRule, PathMatcher и UrlMap.

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

requestHeadersToAdd

complex

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

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

headerName

string

Имя добавляемого заголовка.

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

headerValue

string

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

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

replace

boolean

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

Если значение равно true, для заголовка устанавливается headerValue, а все его прежние значения отбрасываются.

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

requestHeadersToRemove

list / elements=string

Список имен заголовков, которые нужно удалить из запроса перед его пересылкой в backendService.

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

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 / (сумма значений weight всех weightedBackendService в routeAction).

Выбор службы backend выполняется только для нового трафика. После того как запрос пользователя направлен в backendService, последующие запросы будут отправляться в ту же backendService согласно политике привязки сеанса этой BackendService.

Значение должно находиться в диапазоне от 0 до 1000.

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

defaultService

dictionary

Полный или частичный URL ресурса defaultService, на который направляется трафик, если ни одно из правил hostRules не совпадает. Если также указано defaultRouteAction, перед отправкой запроса в backend выполняются расширенные действия маршрутизации, например перезапись URL. Однако если указано defaultService, defaultRouteAction не может содержать weightedBackendServices. И наоборот, если в routeAction указаны weightedBackendServices, параметр service указывать нельзя. Должен быть задан только один из параметров defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService.

Возвращается: 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 сохраняется. По умолчанию задано значение false.

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

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

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

fingerprint

string

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

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

headerAction

complex

Задает изменения заголовков запроса и ответа, применяемые к выбранному backendService. Указанный здесь headerAction применяется после headerAction, заданного в pathMatcher.

Возвращается: 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

hostRules

complex

Список правил HostRules для применения к URL.

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

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

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

hosts

list / elements=string

Список шаблонов узлов для сопоставления. Они должны быть допустимыми именами узлов, за исключением того, что * будет соответствовать любой строке вида ([a-z0-9-.]*). В этом случае * должен быть первым символом, а следующим символом шаблона должен быть - или .

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

pathMatcher

string

Имя PathMatcher, используемого для сопоставления пути URL, если hostRule совпадает с частью URL, содержащей узел.

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

id

integer

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

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

name

string

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

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

pathMatchers

complex

Список именованных PathMatchers для применения к URL.

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

defaultRouteAction

complex

defaultRouteAction применяется, если ни одно из правил pathRules или routeRules не совпадает. Перед перенаправлением запроса к выбранному серверу backend балансировщик нагрузки выполняет расширенные действия маршрутизации, например перезапись URL и преобразование заголовков. Если в defaultRouteAction указаны weightedBackendServices, параметр defaultService задавать нельзя.

И наоборот, если задан параметр defaultService, defaultRouteAction не может содержать weightedBackendServices.

Должен быть задан только один из параметров defaultRouteAction или defaultUrlRedirect.

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

corsPolicy

complex

Настройки, разрешающие междоменные запросы со стороны клиента. См. [рекомендацию W3C по совместному использованию ресурсов между источниками](https://www.w3.org/TR/cors/).

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

allowCredentials

boolean

В ответе на предварительный запрос значение true указывает, что фактический запрос может содержать учетные данные пользователя.

Это соответствует заголовку Access-Control-Allow-Credentials.

Возвращается: 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. Источник разрешен, если он соответствует элементу allowOrigins или элементу allowOriginRegexes.

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

allowOrigins

list / elements=string

Задает список источников, которым разрешено выполнять CORS-запросы.

Источник разрешен, если он соответствует элементу allowOrigins или элементу allowOriginRegexes.

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

disabled

boolean

Если значение равно true, политика CORS отключена. Значение по умолчанию — false, что означает, что политика CORS действует.

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

exposeHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Expose-Headers.

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

maxAge

integer

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

Это соответствует заголовку Access-Control-Max-Age.

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

faultInjectionPolicy

complex

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

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

Параметры timeout и retryPolicy не учитываются клиентами, для которых настроена faultInjectionPolicy.

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

abort

complex

Спецификация прерывания запросов клиентов в рамках внедрения сбоев.

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

httpStatus

integer

Код состояния HTTP, используемый для прерывания запроса.

Значение должно находиться в диапазоне от 200 до 599 включительно.

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

percentage

string

Процент трафика (соединений/операций/запросов), который будет прерван в рамках внедрения сбоев.

Значение должно находиться в диапазоне от 0.0 до 100.0 включительно.

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

delay

complex

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

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

fixedDelay

complex

Задает значение фиксированного интервала задержки.

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

nanos

integer

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

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

seconds

string

Промежуток времени с точностью до секунды. Значение должно находиться в диапазоне от 0 до 315,576,000,000 включительно.

Примечание: эти границы рассчитаны следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

percentage

string

Процент трафика (соединений/операций/запросов), для которого будет введена задержка в рамках внедрения сбоев.

Значение должно находиться в диапазоне от 0.0 до 100.0 включительно.

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

requestMirrorPolicy

complex

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

Балансировщик нагрузки не ожидает ответов от зеркальной службы. Перед отправкой трафика в зеркальную службу к заголовку host / authority добавляется суффикс -shadow.

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

backendService

dictionary

Полный или частичный URL ресурса BackendService, в который направляется зеркальный трафик.

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

retryPolicy

complex

Задает политику повторных попыток для этого маршрута.

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

numRetries

integer

Задает допустимое количество повторных попыток. Это число должно быть > 0. Если параметр не задан, по умолчанию используется значение 1.

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

perTryTimeout

complex

Задает ненулевое время ожидания для каждой повторной попытки.

Если параметр не задан, используется время ожидания, установленное в HttpRouteAction. Если время ожидания в HttpRouteAction не задано, используется наибольшее время ожидания среди всех серверных служб, связанных с маршрутом.

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

nanos

integer

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

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

seconds

string

Промежуток времени с точностью до секунды. Значение должно находиться в диапазоне от 0 до 315,576,000,000 включительно.

Примечание: эти границы рассчитаны следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

retryConditions

list / elements=string

Задает одно или несколько условий, при которых применяется это правило повторных попыток. Допустимые значения: * 5xx: балансировщик нагрузки повторит попытку, если серверная служба вернет любой код ответа 5xx или не ответит вовсе, например при отключении, сбросе соединения, истечении времени ожидания чтения, * сбое соединения и отказе потоков.

* gateway-error: аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504.

* connect-failure: балансировщик нагрузки повторит попытку при сбоях подключения к серверным службам, например из-за истечения времени ожидания соединения.

* retriable-4xx: балансировщик нагрузки повторит попытку при повторяемых кодах ответа 4xx.

В настоящее время поддерживается только одна повторяемая ошибка — 409.

* refused-stream: балансировщик нагрузки повторит попытку, если серверная служба сбросит поток с кодом ошибки REFUSED_STREAM.

Этот тип сброса означает, что повторная попытка безопасна.

* cancelled: балансировщик нагрузки повторит попытку, если в заголовке ответа указан код состояния gRPC cancelled * deadline-exceeded: балансировщик нагрузки повторит попытку, если в заголовке ответа указан код состояния gRPC deadline-exceeded * resource-exhausted: балансировщик нагрузки повторит попытку, если в заголовке ответа указан код состояния gRPC resource-exhausted * unavailable: балансировщик нагрузки повторит попытку, если в заголовке ответа указан код состояния gRPC unavailable.

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

timeout

complex

Задает время ожидания для выбранного маршрута. Отсчет времени ожидания начинается после полной обработки запроса (то есть после завершения потока) и заканчивается после полной обработки ответа. Время ожидания включает все повторные попытки.

Если параметр не задан, используется наибольшее время ожидания среди всех серверных служб, связанных с маршрутом.

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

nanos

integer

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

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

seconds

string

Промежуток времени с точностью до секунды. Значение должно находиться в диапазоне от 0 до 315,576,000,000 включительно.

Примечание: эти границы рассчитаны следующим образом: 60 сек/мин * 60 мин/ч * 24 ч/день * 365.25 дней/год * 10000 лет.

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

urlRewrite

complex

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

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

hostRewrite

string

Перед перенаправлением запроса в выбранную службу заголовок host запроса заменяется содержимым hostRewrite.

Значение должно содержать от 1 до 255 символов.

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

pathPrefixRewrite

string

Перед перенаправлением запроса в выбранную серверную службу соответствующая часть пути запроса заменяется на pathPrefixRewrite.

Значение должно содержать от 1 до 1024 символов.

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

weightedBackendServices

complex

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

Веса определяют долю трафика, направляемую в соответствующую серверную службу.

Если весь трафик должен направляться в одну серверную службу, необходимо указать одну weightedBackendService с ненулевым значением weight.

После определения backendService и перед перенаправлением запроса в серверную службу применяются расширенные действия маршрутизации, например перезапись URL и преобразование заголовков, в соответствии с дополнительными настройками, заданными в этом HttpRouteAction.

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

backendService

dictionary

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

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

headerAction

complex

Задает изменения заголовков запросов и ответов, которые необходимо применить для выбранной backendService.

Указанные здесь действия headerAction применяются до действий headerAction во внешних объектах HttpRouteRule, PathMatcher и UrlMap.

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

requestHeadersToAdd

complex

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

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

headerName

string

Имя добавляемого заголовка.

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

headerValue

string

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

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

replace

boolean

Если значение false, headerValue добавляется к уже существующим значениям заголовка.

Если значение true, для заголовка устанавливается headerValue, а все ранее заданные значения этого заголовка отбрасываются.

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

requestHeadersToRemove

list / elements=string

Список имен заголовков, которые необходимо удалить из запроса перед его перенаправлением в backendService.

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

responseHeadersToAdd

complex

Заголовки, добавляемые к ответу перед его отправкой клиенту.

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

headerName

string

Имя добавляемого заголовка.

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

headerValue

string

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

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

replace

boolean

Если значение false, headerValue добавляется к уже существующим значениям заголовка.

Если значение true, для заголовка устанавливается headerValue, а все ранее заданные значения этого заголовка отбрасываются.

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

responseHeadersToRemove

list / elements=string

Список имен заголовков, которые необходимо удалить из ответа перед его отправкой клиенту.

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

weight

integer

Задает долю трафика, направляемого в backendService, которая рассчитывается как weight / (сумма весов всех weightedBackendService в routeAction).

Выбор серверной службы выполняется только для нового трафика. После того как запрос пользователя направлен в backendService, последующие запросы будут отправляться в ту же backendService в соответствии с политикой привязки сеанса BackendService.

Значение должно находиться в диапазоне от 0 до 1000.

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

defaultService

dictionary

Полный или частичный URL ресурса BackendService. Он используется, если ни одно из правил pathRules или routeRules, заданных в этом PathMatcher, не совпало. Например, допустимы все следующие URL ресурса BackendService: - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService Если дополнительно задан defaultRouteAction, перед отправкой запроса в серверную службу применяются расширенные действия маршрутизации, например перезапись URL. Однако если задан defaultService, параметр defaultRouteAction не может содержать weightedBackendServices. И наоборот, если в defaultRouteAction задан любой weightedBackendServices, параметр defaultService задавать нельзя.

Должен быть задан только один из параметров: defaultService, defaultUrlRedirect или defaultRouteAction.weightedBackendService. Для авторизации требуются одно или несколько из следующих разрешений Google IAM для указанного ресурса defaultService: - compute.backendBuckets.use - compute.backendServices.use.

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

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

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

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

headerAction

complex

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

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

requestHeadersToAdd

complex

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

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

headerName

string

Имя заголовка.

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

headerValue

string

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

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

replace

boolean

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

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

requestHeadersToRemove

list / elements=string

Список имен заголовков, которые необходимо удалить из запроса перед его пересылкой в backendService.

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

responseHeadersToAdd

complex

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

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

headerName

string

Имя заголовка.

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

headerValue

string

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

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

replace

boolean

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

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

responseHeadersToRemove

list / elements=string

Список имен заголовков, которые необходимо удалить из ответа перед его отправкой клиенту.

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

name

string

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

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

pathRules

complex

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

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

paths

list / elements=string

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

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

routeAction

complex

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

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

corsPolicy

complex

Параметры разрешения междоменных запросов со стороны клиента. См. рекомендацию W3C по совместному использованию ресурсов между источниками.

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

allowCredentials

boolean

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

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

allowHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Headers.

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

allowMethods

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Methods.

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

allowOriginRegexes

list / elements=string

Задает шаблоны регулярных выражений, соответствующие разрешенным источникам. Синтаксис регулярных выражений описан на en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует allow_origins или allow_origin_regex.

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

allowOrigins

list / elements=string

Задает список источников, которым разрешено выполнять CORS-запросы. Источник разрешен, если он соответствует allow_origins или allow_origin_regex.

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

disabled

boolean

Если задано значение true, политика CORS отключается.

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

exposeHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Expose-Headers.

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

maxAge

integer

Задает срок хранения в кэше результатов предварительного запроса. Это значение определяет содержимое заголовка Access-Control-Max-Age.

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

faultInjectionPolicy

complex

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

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

abort

complex

Параметры прерывания запросов клиентов в рамках внедрения сбоев.

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

httpStatus

integer

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

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

percentage

string

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

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

delay

complex

Параметры задержки запросов клиентов в рамках внедрения сбоев перед их отправкой серверной службе.

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

fixedDelay

complex

Задает значение фиксированного интервала задержки.

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

nanos

integer

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

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

seconds

string

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

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

percentage

string

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

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

requestMirrorPolicy

complex

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

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

backendService

dictionary

Ресурс BackendService, в который выполняется зеркалирование.

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

retryPolicy

complex

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

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

numRetries

integer

Задает допустимое количество повторных попыток. Это число должно быть больше 0.

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

perTryTimeout

complex

Задает ненулевой тайм-аут для каждой повторной попытки.

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

nanos

integer

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

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

seconds

string

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

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

retryConditions

list / elements=string

Задает одно или несколько условий, при которых применяется это правило повторных попыток. Допустимые значения: * 5xx: балансировщик нагрузки выполнит повторную попытку, если служба backend вернет любой код ответа 5xx или вообще не ответит, например, при разрыве соединения, сбросе, тайм-ауте чтения, сбое подключения или отклонении потоков.

* 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

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

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

nanos

integer

Интервал времени, представляющий долю секунды с точностью до наносекунды. Длительности менее одной секунды представляются значением 0 в поле `seconds` и положительным значением в поле `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 с ненулевым значением weight. После определения backendService и перед перенаправлением запроса в службу backend применяются расширенные действия маршрутизации, например перезапись URL и преобразования заголовков, в зависимости от дополнительных параметров, указанных в этом HttpRouteAction.

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

backendService

dictionary

Ресурс BackendService по умолчанию. Перед перенаправлением запроса в 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 / (сумма всех значений weight в weightedBackendService в routeAction). Служба backend выбирается только для нового трафика. После того как запрос пользователя направлен в backendService, последующие запросы будут отправляться в ту же backendService согласно политике привязки сеанса BackendService.

Значение должно быть в диапазоне от 0 до 1000.

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

service

dictionary

Ресурс службы backend, в которую направляется трафик при совпадении с этим правилом. Если дополнительно указан routeAction, перед отправкой запроса в backend применяются расширенные действия маршрутизации, например перезапись 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

Список названий заголовков, которые необходимо удалить из ответа перед его отправкой клиенту.

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

matchRules

complex

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

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

fullPathMatch

string

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

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

headerMatches

complex

Задает список критериев сопоставления заголовков; все они должны совпадать с соответствующими заголовками запроса.

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

exactMatch

string

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

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

headerName

string

Название HTTP-заголовка для сопоставления. Для сопоставления с authority HTTP-запроса используйте headerMatch с названием заголовка “:authority”. Для сопоставления с методом запроса используйте headerName “:method”.

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

invertMatch

boolean

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

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

prefixMatch

string

Значение заголовка должно начинаться с содержимого prefixMatch. Необходимо задать только один из параметров exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

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

presentMatch

boolean

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

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

rangeMatch

complex

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

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

rangeEnd

integer

Конец диапазона (не включительно).

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

rangeStart

integer

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

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

regexMatch

string

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

Необходимо задать только один из параметров exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

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

suffixMatch

string

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

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

ignoreCase

boolean

Указывает, что сопоставление по prefixMatch и fullPathMatch выполняется с учетом регистра.

По умолчанию — false.

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

metadataFilters

complex

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

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

filterLabels

complex

Список пар «метка — значение», которые должны совпадать с метками в переданных метаданных согласно filterMatchCriteria. Список не должен быть пустым и может содержать не более 64 элементов.

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

name

string

Название метки метаданных. Длина названия не должна превышать 1024 символа и должна составлять не менее 1 символа.

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

value

string

Значение метки должно совпадать с указанным значением. Длина value не должна превышать 1024 символа.

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

filterMatchCriteria

string

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

- MATCH_ALL: все метки filterLabels должны совпадать с метками в переданных метаданных.

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

prefixMatch

string

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

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

queryParameterMatches

complex

Задает список критериев сопоставления параметров запроса; все они должны совпадать с соответствующими параметрами запроса.

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

exactMatch

string

queryParameterMatch считается совпавшим, если значение параметра точно совпадает с содержимым exactMatch. Необходимо задать только один из параметров presentMatch, exactMatch и regexMatch.

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

name

string

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

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

presentMatch

boolean

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

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

regexMatch

string

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

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

regexMatch

string

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

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

priority

integer

Для routeRules в заданном pathMatcher параметр priority определяет порядок обработки routeRules балансировщиком нагрузки. Правила 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

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

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

corsPolicy

complex

Настройки разрешения междоменных запросов со стороны клиента. См. рекомендацию W3C по совместному использованию ресурсов между источниками.

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

allowCredentials

boolean

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

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

allowHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Headers.

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

allowMethods

list / elements=string

Задает содержимое заголовка Access-Control-Allow-Methods.

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

allowOriginRegexes

list / elements=string

Задает шаблоны регулярных выражений для сопоставления с разрешенными источниками. Синтаксис регулярных выражений см. на странице en.cppreference.com/w/cpp/regex/ecmascript. Источник разрешен, если он соответствует allow_origins или allow_origin_regex.

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

allowOrigins

list / elements=string

Задает список источников, которым разрешено выполнять CORS-запросы. Источник разрешен, если он соответствует allow_origins или allow_origin_regex.

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

disabled

boolean

Если задано значение true, политика CORS отключена.

Это указывает на то, что политика CORS действует. По умолчанию — false.

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

exposeHeaders

list / elements=string

Задает содержимое заголовка Access-Control-Expose-Headers.

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

maxAge

integer

Задает срок хранения в кэше результатов предварительного запроса. Это значение передается в заголовок Access-Control-Max-Age.

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

faultInjectionPolicy

complex

Настройки внедрения сбоев в трафик для проверки устойчивости клиентов к отказам серверной службы. При внедрении сбоев, когда клиенты отправляют запросы серверной службе, Loadbalancer может задерживать часть запросов в соответствии с заданным процентом, прежде чем отправить их серверной службе. Аналогично Loadbalancer может прерывать запросы клиентов в соответствии с заданным процентом. Клиенты, для которых настроен fault_injection_policy, будут игнорировать timeout и retry_policy.

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

abort

complex

Настройки прерывания запросов клиентов в рамках внедрения сбоев.

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

httpStatus

integer

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

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

percentage

string

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

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

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

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

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

backendService

dictionary

Ресурс BackendService, в который направляется зеркальная копия.

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

retryPolicy

complex

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

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

numRetries

integer

Задает допустимое число повторных попыток. Это число должно быть > 0.

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

perTryTimeout

complex

Задает ненулевой тайм-аут для каждой повторной попытки.

Если значение не задано, будет использоваться тайм-аут, указанный в HttpRouteAction. Если тайм-аут в HttpRouteAction не задан, будет использоваться наибольший тайм-аут среди всех внутренних служб, связанных с маршрутом.

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

nanos

integer

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

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

seconds

string

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

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

retryConditions

list / elements=string

Задает одно или несколько условий, при которых применяется это правило повторных попыток. Допустимые значения: * 5xx: балансировщик нагрузки предпримет повторную попытку, если внутренняя служба ответит любым кодом 5xx или вообще не ответит, например из-за отключения, сброса соединения, тайм-аута чтения, ошибки соединения или отказа в потоках.

* gateway-error: аналогично 5xx, но применяется только к кодам ответа 502, 503 или 504.

* connect-failure: балансировщик нагрузки повторит попытку при сбоях подключения к внутренним службам, например из-за тайм-аутов соединения.

* retriable-4xx: балансировщик нагрузки повторит попытку при повторяемых кодах ответа 4xx.

В настоящее время поддерживается только одна повторяемая ошибка — 409.

* refused-stream: балансировщик нагрузки повторит попытку, если внутренняя служба сбросит поток с кодом ошибки REFUSED_STREAM. Этот тип сброса указывает на то, что повторная попытка безопасна.

* cancelled: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC cancelled * deadline-exceeded: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC deadline-exceeded * resource-exhausted: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC resource-exhausted * unavailable: балансировщик нагрузки повторит попытку, если в заголовке ответа задан код состояния gRPC unavailable .

Возвращается: 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

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

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

weightedBackendServices

complex

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

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

backendService

dictionary

Ресурс BackendService по умолчанию. Перед перенаправлением запроса в backendService балансировщик нагрузки применяет все соответствующие действия с заголовками, заданные в составе этой 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). Выбор внутренней службы выполняется только для нового трафика. После перенаправления запроса пользователя в backendService последующие запросы будут отправляться в ту же backendService в соответствии с политикой привязки сеансов BackendService.

Значение должно находиться в диапазоне от 0 до 1000.

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

service

dictionary

Ресурс внутренней службы, в которую направляется трафик при совпадении с этим правилом. Если дополнительно задан 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 сохраняется перед перенаправлением запроса.

Возвращается: 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

tests

complex

Список ожидаемых тестов сопоставления URL. Запрос на обновление этого UrlMap будет успешно выполнен, только если пройдены все тестовые случаи. Для одного UrlMap можно указать не более 100 тестов.

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

description

string

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

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

host

string

Часть URL, содержащая имя хоста.

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

path

string

Часть URL, содержащая путь.

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

service

dictionary

Ожидаемый ресурс BackendService, на который должен указывать данный URL.

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