Модуль google.cloud.gcp_compute_region_url_map_info – сбор сведений о GCP RegionUrlMap

access_token

string

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

auth_kind

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

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

Допустимые значения:

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

env_type

string

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

Не задавайте это значение, если не уверены в своих действиях.

Этот параметр изменяет только строку User Agent для запросов к API.

filters

list / элементы=string

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

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

project

string

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

region

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

Ссылка на регион, в котором находится карта URL.

scopes

list / элементы=string

Массив областей доступа, которые следует использовать

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

resources

complex

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

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

creationTimestamp

string

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

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

defaultService

dictionary

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

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

defaultUrlRedirect

complex

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

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

hostRedirect

string

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

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

httpsRedirect

boolean

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

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

pathRedirect

string

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

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

prefixRedirect

string

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

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

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

redirectResponseCode

string

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

* FOUND — соответствует коду 302.

* SEE_OTHER — соответствует коду 303.

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

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

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

stripQuery

boolean

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

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

description

string

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

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

fingerprint

string

Отпечаток этого ресурса. Это поле используется внутри системы при обновлении ресурса.

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

hostRules

complex

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

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

description

string

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

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

hosts

list / elements=string

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

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

pathMatcher

string

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

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

id

integer

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

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

name

string

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

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

pathMatchers

complex

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

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

defaultService

dictionary

Ссылка на ресурс RegionBackendService. Он будет использоваться, если путь URL не совпадет ни с одним из правил pathRules, заданных для этого PathMatcher.

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

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

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

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

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 по обмену ресурсами между источниками (Cross-Origin Resource Sharing).

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

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

Параметры внедрения сбоев в трафик для проверки устойчивости клиентов к отказам серверной службы. При внедрении сбоев, когда клиенты отправляют запросы серверной службе, балансировщик нагрузки может задерживать часть запросов перед их отправкой на серверную службу. Аналогично балансировщик нагрузки может прерывать часть запросов клиентов. Параметры timeout и retry_policy игнорируются клиентами, настроенными с политикой fault_injection_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

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

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

retryPolicy

complex

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

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

numRetries

integer

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

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

perTryTimeout

complex

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

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

nanos

integer

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

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

seconds

string

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

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

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

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

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

nanos

integer

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

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

seconds

string

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

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

urlRewrite

complex

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

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

hostRewrite

string

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

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

pathPrefixRewrite

string

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

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

weightedBackendServices

complex

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

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

backendService

dictionary

Ресурс RegionBackendService по умолчанию. Перед перенаправлением запроса в 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

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

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

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.

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

service

dictionary

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

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

urlRedirect

complex

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

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

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 сохраняются.

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

routeRules

complex

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

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

headerAction

complex

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

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

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

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

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

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 для сопоставления. Для сопоставления с полномочиями 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 могут переопределять значения, заданные в ForwardingRule, ссылающемся на этот UrlMap. metadataFilters применяются только к Loadbalancers, для которых параметр 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 проверяются в порядке приоритета — от наименьшего числа к наибольшему. Приоритет правила уменьшается по мере увеличения его номера (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 по обмену ресурсами между источниками (Cross Origin Resource Sharing).

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

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

Настройки внедрения сбоев в трафик для проверки устойчивости клиентов к отказам серверной службы. При внедрении сбоев, когда клиенты отправляют запросы серверной службе, балансировщик нагрузки может задерживать часть запросов перед их отправкой серверной службе. Аналогичным образом балансировщик нагрузки может прерывать часть запросов клиентов. Клиенты, для которых настроена 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

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

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

retryPolicy

complex

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

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

numRetries

integer

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

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

perTryTimeout

complex

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

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

nanos

integer

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

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

seconds

string

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

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

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

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

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

nanos

integer

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

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

seconds

string

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

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

urlRewrite

complex

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

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

hostRewrite

string

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

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

pathPrefixRewrite

string

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

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

weightedBackendServices

complex

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

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

backendService

dictionary

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

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

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

service

dictionary

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

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

urlRedirect

complex

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

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

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 сохраняются. Значение по умолчанию — false.

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

region

string

Ссылка на регион, в котором находится карта URL.

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

tests

complex

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

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

description

string

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

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

host

string

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

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

path

string

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

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

service

dictionary

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

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