Модуль google.cloud.gcp_compute_url_map_info – Сбор информации о GCP UrlMap

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

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

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

timeout и retryPolicy будут игнорироваться клиентами, которые настроены с faultInjectionPolicy.

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

abort

complex

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

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

httpStatus

integer

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

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

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

percentage

string

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

Значение должно быть от 0,0 до 100,0 включительно.

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

delay

complex

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

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

fixedDelay

complex

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

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

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

percentage

string

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

Значение должно быть от 0,0 до 100,0 включительно.

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

requestMirrorPolicy

complex

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

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

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

backendService

dictionary

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

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

retryPolicy

complex

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

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

numRetries

integer

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

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

perTryTimeout

complex

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

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

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

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

retryConditions

list / elements=string

Указывает одно или несколько условий, когда применяется это правило повтора. Допустимые значения: * 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.

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

timeout

complex

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

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

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

nanos

integer

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

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

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

Возвращено: success

urlRewrite

complex

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

Возвращено: success

hostRewrite

string

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

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

Возвращено: success

pathPrefixRewrite

string

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

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

Возвращено: success

weightedBackendServices

complex

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

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

Если весь трафик должен идти к одному сервису бекенда, должен быть один weightedBackendService с весом, отличным от 0.

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

Возвращено: success

backendService

dictionary

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

Возвращено: success

headerAction

complex

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

headerAction, указанные здесь, вступают в силу перед headerAction в включающем HttpRouteRule, PathMatcher и UrlMap.

Возвращено: success

requestHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

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

Возвращено: success

requestHeadersToRemove

list / elements=string

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

Возвращено: success

responseHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

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

Возвращено: success

responseHeadersToRemove

list / elements=string

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

Возвращено: success

weight

integer

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

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

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

Возвращено: success

defaultService

dictionary

Полный или частичный URL ресурса defaultService, на который направляется трафик, если ни одно из правил hostRules не совпадает. Если дополнительно указан defaultRouteAction, то перед отправкой запроса на бэкэнд применяются расширенные действия маршрутизации, такие как переписывание 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 не соответствует. Балансировщик нагрузки выполняет расширенные действия маршрутизации, такие как переписывание 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.

Возвращено: success

abort

complex

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

Возвращено: success

httpStatus

integer

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

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

Возвращено: success

percentage

string

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

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

Возвращено: success

delay

complex

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

Возвращено: success

fixedDelay

complex

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

Возвращено: success

percentage

string

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

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

Возвращено: success

requestMirrorPolicy

complex

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

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

Возвращено: success

backendService

dictionary

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

Возвращено: success

retryPolicy

complex

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

Возвращено: success

numRetries

integer

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

Возвращено: success

perTryTimeout

complex

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

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

Возвращено: success

retryConditions

list / elements=string

Указывает одно или несколько условий, когда применяется это правило повтора. Допустимые значения: * 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.

Возвращено: success

timeout

complex

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

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Примечание: эти границы вычисляются из: 60 сек/мин * 60 мин/час * 24 час/день * 365,25 дней/год * 10000 лет.

Возвращено: success

urlRewrite

complex

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

Возвращено: success

hostRewrite

string

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

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

Возвращено: success

pathPrefixRewrite

string

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

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

Возвращено: success

weightedBackendServices

complex

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

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

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

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

Возвращено: success

backendService

dictionary

Полный или частичный URL-адрес ресурса службы по умолчанию 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 / (сумма всех весов weightedBackendService в routeAction).

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

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

Возвращено: success

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 .

Возвращено: success

defaultUrlRedirect

complex

Если ни одно из указанных правил hostRules не соответствует, запрос перенаправляется на URL-адрес, указанный в defaultUrlRedirect. Если указан defaultUrlRedirect, defaultService или defaultRouteAction не должны быть установлены.

Возвращено: success

hostRedirect

string

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

Возвращено: success

httpsRedirect

boolean

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

Возвращено: success

pathRedirect

string

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

Возвращено: success

prefixRedirect

string

Префикс, который заменяет prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL-адреса перед перенаправлением запроса.

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

Возвращено: success

redirectResponseCode

string

Код состояния HTTP, который будет использоваться для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, это значение по умолчанию и соответствует 301.

* FOUND, что соответствует 302.

* SEE_OTHER, что соответствует 303.

* TEMPORARY_REDIRECT, что соответствует 307. В этом случае метод запроса будет сохранен.

* PERMANENT_REDIRECT, что соответствует 308. В этом случае метод запроса будет сохранен.

Возвращено: success

stripQuery

boolean

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

Возвращено: success

description

string

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

Возвращено: success

headerAction

complex

Указывает изменения заголовков запроса и ответа, которые должны вступить в силу для выбранного backendService. HeaderAction, указанные здесь, применяются после соответствующего HeaderAction HttpRouteRule и перед HeaderAction в 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

name

string

Имя, по которому к этому PathMatcher обращается HostRule.

Возвращено: success

pathRules

complex

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

Возвращено: success

paths

list / elements=string

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

Возвращено: success

routeAction

complex

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

Возвращено: success

corsPolicy

complex

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

Возвращено: success

allowCredentials

boolean

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

Возвращено: success

allowHeaders

list / elements=string

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

Возвращено: success

allowMethods

list / elements=string

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

Возвращено: success

allowOriginRegexes

list / elements=string

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

Возвращено: success

allowOrigins

list / elements=string

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

Возвращено: success

disabled

boolean

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

Возвращено: success

exposeHeaders

list / elements=string

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

Возвращено: success

maxAge

integer

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

Возвращено: success

faultInjectionPolicy

complex

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

Возвращено: success

abort

complex

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

Возвращено: success

httpStatus

integer

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

Возвращено: success

percentage

string

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

Возвращено: success

delay

complex

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

Возвращено: success

fixedDelay

complex

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Возвращено: success

percentage

string

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

Возвращено: success

requestMirrorPolicy

complex

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

Возвращено: success

backendService

dictionary

Ресурс BackendService, который отражается.

Возвращено: success

retryPolicy

complex

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

Возвращено: success

numRetries

integer

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

Возвращено: success

perTryTimeout

complex

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Возвращено: success

retryConditions

list / elements=string

Указывает одно или несколько условий, когда применяется это правило повторной попытки. Допустимые значения: * 5xx: балансировщик нагрузки предпримет повторную попытку, если бэкэнд-сервис отвечает кодом ответа 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 с весом, отличным от 0. После определения бэкэнд-сервиса и перед переадресацией запроса на бэкэнд-сервис применяются дополнительные действия маршрутизации, такие как переписывание 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

значениеЗаголовка

строка

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

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

заменить

булево

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

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

удалитьЗаголовкиЗапроса

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

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

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

добавитьЗаголовкиОтвета

сложное

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

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

имяЗаголовка

строка

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

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

значениеЗаголовка

строка

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

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

заменить

булево

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

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

удалитьЗаголовкиОтвета

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

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

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

вес

целое число

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

Значение должно быть между 0 и 1000.

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

сервис

словарь

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

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

перенаправлениеUrl

сложное

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

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

перенаправлениеХоста

строка

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

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

перенаправлениеHttps

булево

Если установлено в true, схема URL в перенаправляемом запросе устанавливается в https.

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

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

перенаправлениеПути

строка

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

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

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

перенаправлениеПрефикса

строка

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

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

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

redirectResponseCode

string

HTTP-код состояния, используемый для этого RedirectAction. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT, значение по умолчанию, соответствует 301.

* FOUND, соответствует 302.

* SEE_OTHER, соответствует 303.

* TEMPORARY_REDIRECT, соответствует 307. В этом случае метод запроса сохраняется.

* PERMANENT_REDIRECT, соответствует 308. В этом случае метод запроса сохраняется.

Возвращено: success

stripQuery

boolean

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

Возвращено: success

routeRules

complex

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

Возвращено: success

headerAction

complex

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

Возвращено: success

requestHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

Возвращено: success

requestHeadersToRemove

list / elements=string

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

Возвращено: success

responseHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

Возвращено: success

responseHeadersToRemove

list / elements=string

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

Возвращено: success

matchRules

complex

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

Возвращено: success

fullPathMatch

string

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

Возвращено: success

headerMatches

complex

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

Возвращено: success

exactMatch

string

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

Возвращено: success

headerName

string

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

Возвращено: success

invertMatch

boolean

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

Возвращено: success

prefixMatch

string

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

Возвращено: success

presentMatch

boolean

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

Возвращено: success

rangeMatch

complex

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

Возвращено: success

rangeEnd

integer

Конец диапазона (исключая).

Возвращено: success

rangeStart

integer

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

Возвращено: success

regexMatch

string

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

Должно быть установлено только одно из exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch или rangeMatch.

Возвращено: success

suffixMatch

string

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

Возвращено: success

ignoreCase

boolean

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

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

Возвращено: success

metadataFilters

complex

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

Возвращено: success

filterLabels

complex

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

Возвращено: success

name

string

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

Возвращено: success

значение

строка

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

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

filterMatchCriteria

строка

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

• MATCH_ALL: Все filterLabels должны иметь соответствующие метки в предоставленных метаданных.

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

prefixMatch

строка

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

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

queryParameterMatches

сложный тип

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

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

exactMatch

строка

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

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

имя

строка

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

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

presentMatch

булево

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

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

regexMatch

строка

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

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

regexMatch

строка

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

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

приоритет

целое число

Для routeRules в заданном pathMatcher приоритет определяет порядок интерпретации routeRules балансировщиком нагрузки. RouteRules оцениваются в порядке приоритета, от меньшего к большему числу. Приоритет правила уменьшается с увеличением его номера (1, 2, 3, N+1). Применяется первое правило, которое соответствует запросу.

Вы не можете настроить два или более routeRules с одинаковым приоритетом.

Приоритет каждого правила должен быть установлен на число от 0 до 2147483647 включительно.

Номера приоритета могут иметь пробелы, что позволяет добавлять или удалять правила в будущем без влияния на остальные правила. Например, 1, 2, 3, 4, 5, 9, 12, 16 — это допустимый ряд номеров приоритетов, к которому вы можете добавить правила с номерами от 6 до 8, 10 до 11 и 13 до 15 в будущем без каких-либо последствий для существующих правил.

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

routeAction

сложный тип

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

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

corsPolicy

сложный тип

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

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

allowCredentials

булево

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

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

allowHeaders

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

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

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

allowMethods

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

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

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

allowOriginRegexes

list / elements=string

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

Возвращено: success

allowOrigins

list / elements=string

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

Возвращено: success

disabled

boolean

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

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

Возвращено: success

exposeHeaders

list / elements=string

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

Возвращено: success

maxAge

integer

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

Возвращено: success

faultInjectionPolicy

complex

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

Возвращено: success

abort

complex

Спецификация того, как прерываются запросы клиентов как часть инъекции ошибок.

Возвращено: success

httpStatus

integer

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

Возвращено: success

percentage

string

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

Возвращено: success

delay

complex

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

Возвращено: success

fixedDelay

complex

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

Возвращено: success

nanos

integer

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

Возвращено: success

seconds

string

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

Возвращено: success

percentage

string

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

Возвращено: success

requestMirrorPolicy

complex

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

Возвращено: success

backendService

dictionary

Зеркалируемый ресурс BackendService.

Возвращено: success

retryPolicy

complex

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

Возвращаемое значение: success

numRetries

целое число

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

Возвращаемое значение: success

perTryTimeout

complex

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

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

Возвращаемое значение: success

nanos

целое число

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

Возвращаемое значение: success

seconds

строка

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

Возвращаемое значение: success

retryConditions

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

Указывает одно или несколько условий, когда применяется это правило повторной обработки. Допустимые значения: * 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.

Возвращаемое значение: success

timeout

complex

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

Возвращаемое значение: success

nanos

целое число

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

Возвращаемое значение: success

seconds

строка

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

Возвращаемое значение: success

urlRewrite

complex

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

Возвращаемое значение: success

headerAction

complex

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

Возвращено: success

requestHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

Возвращено: success

requestHeadersToRemove

list / elements=string

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

Возвращено: success

responseHeadersToAdd

complex

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

Возвращено: success

headerName

string

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

Возвращено: success

headerValue

string

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

Возвращено: success

replace

boolean

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

Возвращено: success

responseHeadersToRemove

list / elements=string

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

Возвращено: success

weight

integer

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

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

Возвращено: success

service

dictionary

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

строка

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

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

prefixRedirect

строка

Префикс, заменяющий prefixMatch, указанный в HttpRouteRuleMatch, сохраняя оставшуюся часть URL перед перенаправлением запроса.

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

redirectResponseCode

строка

Код HTTP-статуса для перенаправления. Поддерживаемые значения: * MOVED_PERMANENTLY_DEFAULT (по умолчанию, соответствует 301).

* FOUND (соответствует 302).

* SEE_OTHER (соответствует 303).

* TEMPORARY_REDIRECT (соответствует 307. В этом случае метод запроса сохраняется).

* PERMANENT_REDIRECT (соответствует 308. В этом случае метод запроса сохраняется).

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

stripQuery

булево

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

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

tests

сложное

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

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

описание

строка

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

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

хост

строка

Часть хоста URL.

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

путь

строка

Часть пути URL.

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

сервис

словарь

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

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