- Recurso: HttpRoute
- RouteRule
- RouteMatch
- HeaderMatch
- IntegerRange
- QueryParameterMatch
- RouteAction
- Destino
- HeaderModifier
- Redireccionamiento
- ResponseCode
- FaultInjectionPolicy
- Demora
- Anular
- URLRewrite
- RetryPolicy
- RequestMirrorPolicy
- CorsPolicy
- StatefulSessionAffinityPolicy
- HttpDirectResponse
- Métodos
Recurso: HttpRoute
HttpRoute es el recurso que define cómo se debe enrutar el tráfico HTTP mediante un recurso de malla o puerta de enlace.
Representación JSON |
---|
{
"name": string,
"selfLink": string,
"description": string,
"createTime": string,
"updateTime": string,
"hostnames": [
string
],
"meshes": [
string
],
"gateways": [
string
],
"labels": {
string: string,
...
},
"rules": [
{
object ( |
Campos | |
---|---|
name |
Obligatorio. Es el nombre del recurso HttpRoute. Coincide con el patrón |
selfLink |
Solo salida. URL definida por el servidor de este recurso |
description |
Opcional. Es una descripción de texto libre del recurso. Longitud máxima: 1,024 caracteres. |
createTime |
Solo salida. Marca de tiempo cuando se creó el recurso. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
updateTime |
Solo salida. Marca de tiempo de la actualización del recurso. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
hostnames[] |
Obligatorio. Los nombres de host definen un conjunto de hosts que deben coincidir con el encabezado de host HTTP para seleccionar una HttpRoute que procese la solicitud. El nombre de host es el nombre de dominio completamente calificado de un host de red, según lo define RFC 1123, con la excepción de lo siguiente: - No se permiten las direcciones IP. - Un nombre de host puede tener un prefijo con una etiqueta comodín ( El nombre de host puede ser "preciso" que es un nombre de dominio sin el punto de finalización de un host de red (p.ej., Ten en cuenta que, según las RFC1035 y RFC1123, una etiqueta debe constar de caracteres alfanuméricos en minúscula o “-”, y debe comenzar y terminar con un carácter alfanumérico. No se permite ningún otro tipo de puntuación. Las rutas asociadas con una malla o puertas de enlace deben tener nombres de host únicos. Si intentas conectar varias rutas con nombres de host en conflicto, se rechazará la configuración. Por ejemplo, si bien es aceptable que las rutas de los nombres de host |
meshes[] |
Opcional. Meshes define una lista de mallas a las que se adjunta esta HttpRoute, como una de las reglas de enrutamiento para enrutar las solicitudes que entrega la malla. Cada referencia de malla debe coincidir con el patrón: La malla adjunta debe ser de tipo SIDECAR. |
gateways[] |
Opcional. Las puertas de enlace definen una lista de puertas de enlace a las que se adjunta esta HttpRoute, como una de las reglas de enrutamiento para enrutar las solicitudes que entrega la puerta de enlace. Cada referencia de puerta de enlace debe coincidir con el patrón: |
labels |
Opcional. Conjunto de etiquetas de etiqueta asociadas con el recurso HttpRoute. Un objeto que contiene una lista de pares |
rules[] |
Obligatorio. Son reglas que definen cómo se enruta y controla el tráfico. Las reglas se encontrarán de forma secuencial según el RouteMatch especificado para la regla. |
RouteRule
Especifica cómo hacer coincidir el tráfico y cómo enrutarlo cuando coincide.
Representación JSON |
---|
{ "matches": [ { object ( |
Campos | |
---|---|
matches[] |
Una lista de coincidencias define las condiciones que se usan para hacer coincidir la regla con las solicitudes HTTP entrantes. Cada coincidencia es independiente, es decir, esta regla se comparará si se cumple CUALQUIERA de las coincidencias. Si no se especifica un campo de coincidencias, esta regla coincidirá con el tráfico de forma incondicional. Si deseas configurar una regla predeterminada, agrega una regla sin coincidencias especificadas al final de la lista de reglas. |
action |
La regla detallada que define cómo enrutar el tráfico coincidente. |
RouteMatch
RouteMatch define las especificaciones que se usan para hacer coincidir las solicitudes. Si se establecen varios tipos de coincidencias, esta RouteMatch coincidirá si coinciden TODOS los tipos de coincidencias.
Representación JSON |
---|
{ "ignoreCase": boolean, "headers": [ { object ( |
Campos | |
---|---|
ignoreCase |
Especifica si las coincidencias dePrefixMatch y fullPathMatch distinguen entre mayúsculas y minúsculas. El valor predeterminado es falso. |
headers[] |
Especifica una lista de encabezados de solicitud HTTP con los que se deben establecer coincidencias. TODOS los encabezados proporcionados deben coincidir. |
queryParameters[] |
Especifica una lista de parámetros de consulta con los que debe coincidir. TODOS los parámetros de consulta deben coincidir. |
Campo de unión
|
|
fullPathMatch |
El valor de la ruta de la solicitud HTTP debe coincidir exactamente con este valor. Solo se debe usar uno de fullPathMatch, prefixMatch o regexMatch. |
prefixMatch |
El valor de la ruta de la solicitud HTTP debe comenzar con el prefixMatch especificado. prefixMatch debe comenzar con una /. Solo se debe usar uno de fullPathMatch, prefixMatch o regexMatch. |
regexMatch |
El valor de la ruta de la solicitud HTTP debe satisfacer la expresión regular especificada por regexMatch después de quitar los parámetros de consulta y el ancla proporcionados con la URL original. Para conocer la gramática de expresiones regulares, consulta https://github.com/google/re2/wiki/Syntax Solo se debe usar fullPathMatch, prefixMatch o regexMatch. |
HeaderMatch
Especifica cómo seleccionar una regla de enrutamiento basada en encabezados de solicitud HTTP.
Representación JSON |
---|
{ "header": string, "invertMatch": boolean, // Union field |
Campos | |
---|---|
header |
El nombre del encabezado HTTP con el que se debe buscar la coincidencia. |
invertMatch |
Si se especifica, el resultado de la coincidencia se invertirá antes de la verificación. El valor predeterminado se establece en falso. |
Campo de unión
|
|
exactMatch |
El valor del encabezado debe coincidir exactamente con el contenido de previousMatch. |
regexMatch |
El valor del encabezado debe coincidir con la expresión regular especificada en regexMatch. Para obtener información sobre la gramática de expresiones regulares, consulta https://github.com/google/re2/wiki/Syntax |
prefixMatch |
El valor del encabezado debe comenzar con el contenido de prefixMatch. |
presentMatch |
Debe existir un encabezado con headerName. La coincidencia se produce independientemente de que el encabezado tenga o no un valor. |
suffixMatch |
El valor del encabezado debe terminar con el contenido de suffixMatch. |
rangeMatch |
Si se especifica, la regla coincidirá si el valor del encabezado de la solicitud está dentro del rango. |
IntegerRange
Representa un rango de valores enteros.
Representación JSON |
---|
{ "start": integer, "end": integer } |
Campos | |
---|---|
start |
Inicio del rango (incluido) |
end |
Fin del período (exclusivo) |
QueryParameterMatch
Especificaciones para hacer coincidir un parámetro de consulta en la solicitud.
Representación JSON |
---|
{ "queryParameter": string, // Union field |
Campos | |
---|---|
queryParameter |
El nombre del parámetro de consulta con el que se buscarán coincidencias. |
Campo de unión
|
|
exactMatch |
El valor del parámetro de consulta debe coincidir exactamente con el contenido de exactMatch. Solo se debe establecer una coincidencia exacta, regexMatch o presenteMatch. |
regexMatch |
El valor del parámetro de consulta debe coincidir con la expresión regular especificada por regexMatch. Para conocer la gramática de expresiones regulares, consulta https://github.com/google/re2/wiki/Syntax Solo se debe configurar una de las siguientes opciones: exactMatch, regexMatch o presentMatch. |
presentMatch |
Especifica que QueryParameterMatcher coincide si la solicitud contiene un parámetro de consulta, sin importar si el parámetro tiene un valor o no. Solo se debe establecer una coincidencia exacta, regexMatch o presenteMatch. |
RouteAction
Las especificaciones para enrutar el tráfico y aplicar las políticas asociadas.
Representación JSON |
---|
{ "destinations": [ { object ( |
Campos | |
---|---|
destinations[] |
Es el destino al que se debe reenviar el tráfico. |
redirect |
Si se establece, la solicitud se dirige según lo configurado en este campo. |
faultInjectionPolicy |
La especificación para la inserción de fallas que se introduce en el tráfico para probar la capacidad de recuperación de los clientes ante fallas del servicio de backend. Como parte de la inserción de errores, cuando los clientes envían solicitudes a un servicio de backend, se pueden introducir retrasos en un porcentaje de las solicitudes antes de enviarlas al servicio de backend. De forma similar, las solicitudes de los clientes se pueden anular para un porcentaje de solicitudes. Los clientes que estén configurados con failInjectionPolicy ignorarán el tiempo de espera y la política de reintentos |
requestHeaderModifier |
Es la especificación para modificar los encabezados de una solicitud coincidente antes de entregarla al destino. Si se configuran HeaderModifiers en el destino y en RouteAction, se combinarán. Los conflictos entre ambos no se resolverán en la configuración. |
responseHeaderModifier |
Es la especificación para modificar los encabezados de una respuesta antes de enviarla al cliente. Si se establecen HeaderModifiers en el destino y en RouteAction, se combinarán. Los conflictos entre ambos no se resolverán en la configuración. |
urlRewrite |
La especificación para reescribir URL antes de reenviar solicitudes al destino. |
timeout |
Especifica el tiempo de espera para la ruta seleccionada. El tiempo de espera se calcula desde el momento en que la solicitud se procesa por completo (es decir, el final de la transmisión) hasta que la respuesta se procesa por completo. El tiempo de espera incluye todos los reintentos. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
retryPolicy |
Especifica la política de reintentos asociada con esta ruta. |
requestMirrorPolicy |
Especifica la política sobre cómo las solicitudes previstas para el destino de las rutas se implementan en paralelo en un destino duplicado independiente. El proxy no esperará a que el destino en sombra responda antes de mostrar la respuesta. Antes de enviar tráfico al servicio paralelo, el encabezado de host o autoridad tiene el sufijo -shadow. |
corsPolicy |
La especificación para permitir solicitudes de origen cruzado del cliente. |
statefulSessionAffinity |
Opcional. Especifica la afinidad de sesión con estado basada en cookies. |
directResponse |
Opcional. Es un objeto de respuesta HTTP estático que se mostrará independientemente de la solicitud. |
idleTimeout |
Opcional. Especifica el tiempo de espera de inactividad para la ruta seleccionada. El tiempo de espera de inactividad se define como el período en el que no se envían ni reciben bytes en la conexión ascendente o descendente. Si no se establece, el tiempo de espera de inactividad predeterminado es de 1 hora. Si se establece en 0 s, se inhabilitará el tiempo de espera. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
Destino
Especificaciones del destino al que se debe enrutar la solicitud.
Representación JSON |
---|
{ "serviceName": string, "weight": integer, "requestHeaderModifier": { object ( |
Campos | |
---|---|
serviceName |
La URL de un BackendService al que se enrutará el tráfico. |
weight |
Especifica la proporción de solicitudes que se reenvían al backend al que hace referencia el campo serviceName. Esto se calcula de la siguiente manera: - peso/Suma(pesos en esta lista de destinos). Para valores distintos de cero, puede haber un valor de épsilon de la proporción exacta definida aquí según la precisión que admita una implementación. Si solo se especifica un serviceName y tiene un peso superior a 0, el 100% del tráfico se reenvía a ese backend. Si se especifican pesos para un nombre de servicio, se deben especificar para todos. Si no se especifican las ponderaciones para todos los servicios, el tráfico se distribuye en proporciones iguales entre todos ellos. |
requestHeaderModifier |
Opcional. Es la especificación para modificar los encabezados de una solicitud coincidente antes de que se entregue al destino. Si se configuran HeaderModifiers en el destino y en RouteAction, se combinarán. Los conflictos entre ambos no se resolverán en la configuración. |
responseHeaderModifier |
Opcional. Es la especificación para modificar los encabezados de una respuesta antes de enviarla al cliente. Si se configuran HeaderModifiers en el destino y en RouteAction, se combinarán. Los conflictos entre ambos no se resolverán en la configuración. |
HeaderModifier
Es la especificación para modificar el encabezado HTTP en la solicitud HTTP y la respuesta HTTP.
Representación JSON |
---|
{ "set": { string: string, ... }, "add": { string: string, ... }, "remove": [ string ] } |
Campos | |
---|---|
set |
Reemplaza completamente los encabezados con el mapa determinado, en el que la clave es el nombre del encabezado y el valor es el valor del encabezado. Un objeto que contiene una lista de pares |
add |
Agrega los encabezados con un mapa determinado en el que la clave sea el nombre del encabezado y el valor sea el valor del encabezado. Un objeto que contiene una lista de pares |
remove[] |
Quita los encabezados (que coinciden con los nombres de encabezado) especificados en la lista. |
Redireccionamiento
La especificación para redireccionar el tráfico.
Representación JSON |
---|
{
"hostRedirect": string,
"pathRedirect": string,
"prefixRewrite": string,
"responseCode": enum ( |
Campos | |
---|---|
hostRedirect |
El host que se usará en la respuesta de redireccionamiento en lugar del que se proporcionó en la solicitud. |
pathRedirect |
Es la ruta que se usará en la respuesta de redireccionamiento en lugar de la que se proporcionó en la solicitud. pathRedirect no se puede proporcionar junto con prefixRedirect. Proporciona uno solo o ninguno. Si no se proporciona ninguna, se usará la ruta de la solicitud original para el redireccionamiento. |
prefixRewrite |
Indica que, durante la redirección, el prefijo (o la ruta de acceso) coincidente se debe intercambiar con este valor. Esta opción permite crear URLs de forma dinámica en función de la solicitud. |
responseCode |
Es el código de estado HTTP que se usará para el redireccionamiento. |
httpsRedirect |
Si se establece como verdadero, el esquema de URL en la solicitud redireccionada se establece en https. Si se establece como "false", el esquema de URL de la solicitud redireccionada seguirá siendo el mismo que el de la solicitud. El valor predeterminado es falso. |
stripQuery |
Si la estableces como verdadera, se quitará cualquier parte de la consulta complementaria de la URL original antes de redireccionar la solicitud. Si la estableces como falsa, se conservará la porción de consulta de la URL original. El valor predeterminado es falso. |
portRedirect |
El puerto que se usará en la solicitud de redireccionamiento en lugar del que se proporcionó en la solicitud. |
ResponseCode
Código de respuesta HTTP compatible.
Enums | |
---|---|
RESPONSE_CODE_UNSPECIFIED |
Valor predeterminado |
MOVED_PERMANENTLY_DEFAULT |
Corresponde a 301. |
FOUND |
Corresponde a 302. |
SEE_OTHER |
Corresponde a 303. |
TEMPORARY_REDIRECT |
Corresponde a 307. En este caso, se conservará el método de la solicitud. |
PERMANENT_REDIRECT |
Corresponde a 308. En este caso, se conservará el método de la solicitud. |
FaultInjectionPolicy
Es la especificación de la inserción de errores que se introdujo en el tráfico para probar la resiliencia de los clientes ante la falla del servicio de destino. Como parte de la inserción de errores, cuando los clientes envían solicitudes a un destino, el proxy del cliente puede introducir demoras en un porcentaje de solicitudes antes de enviarlas al servicio de destino. Del mismo modo, el proxy del cliente puede abortar las solicitudes para un porcentaje de solicitudes.
Representación JSON |
---|
{ "delay": { object ( |
Campos | |
---|---|
delay |
La especificación para insertar un retraso en las solicitudes de los clientes. |
abort |
La especificación para anular las solicitudes de los clientes. |
Retraso
Especificación de cómo se retrasan las solicitudes de los clientes como parte de la inyección de fallas antes de enviarse a un destino.
Representación JSON |
---|
{ "fixedDelay": string, "percentage": integer } |
Campos | |
---|---|
fixedDelay |
Especifica un retraso fijo antes de reenviar la solicitud. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
percentage |
El porcentaje de tráfico en el que se insertará el retraso. El valor debe estar entre [0, 100] |
Anular
Especificación de cómo se abortan las solicitudes del cliente como parte de la inyección de fallas antes de enviarlas a un destino.
Representación JSON |
---|
{ "httpStatus": integer, "percentage": integer } |
Campos | |
---|---|
httpStatus |
El código de estado HTTP que se usa para anular la solicitud. El valor debe estar entre 200 y 599 inclusive. |
percentage |
Es el porcentaje de tráfico que se abortará. El valor debe estar entre [0, 100] |
URLRewrite
Es la especificación para modificar la URL de la solicitud antes de reenviarla al destino.
Representación JSON |
---|
{ "pathPrefixRewrite": string, "hostRewrite": string } |
Campos | |
---|---|
pathPrefixRewrite |
Antes de reenviar la solicitud al destino seleccionado, la parte coincidente de la ruta de la solicitud se reemplaza por este valor. |
hostRewrite |
Antes de reenviar la solicitud al destino seleccionado, el encabezado del host de solicitudes se reemplaza por este valor. |
RetryPolicy
Las especificaciones de los reintentos.
Representación JSON |
---|
{ "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": string } |
Campos | |
---|---|
retryConditions[] |
Especifica una o más condiciones cuando se aplica esta política de reintento. Los valores válidos son los siguientes: 5xx: El proxy intentará volver a intentarlo si el servicio de destino responde con cualquier código de respuesta 5xx o si el servicio de destino no responde en absoluto, por ejemplo: desconexión, restablecimiento, tiempo de espera de lectura, falla de conexión y transmisiones rechazadas. Gate-error: Es similar a 5xx, pero solo se aplica a los códigos de respuesta 502, 503 y 504. Restablecer: El proxy intentará volver a intentarlo si el servicio de destino no responde en absoluto (tiempo de espera de desconexión, restablecimiento o lectura). Connect-failure: El proxy volverá a intentarlo si se produce un error en la conexión al destino, por ejemplo, debido a que se agotó el tiempo de espera de la conexión. retriable-4xx: El proxy volverá a intentar con los códigos de respuesta 4xx recuperables. Por el momento, el único error que se puede recuperar es el 409. rechazad-stream: El proxy volverá a intentarlo si el destino restablece la transmisión con un código de error REFused_STREAM. Este tipo de restablecimiento indica que es seguro volver a intentarlo. |
numRetries |
Especifica la cantidad permitida de reintentos. Este número debe ser mayor que 0. Si no se especifica, el valor predeterminado es 1. |
perTryTimeout |
Especifica un tiempo de espera distinto de cero por intento de reintento. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
RequestMirrorPolicy
Especifica la política sobre cómo se sombrean las solicitudes a un servicio de destino reflejado independiente. El proxy no espera respuestas del servicio paralelo. Antes de enviar tráfico al servicio paralelo, el encabezado de host o autoridad tiene el sufijo -shadow.
Representación JSON |
---|
{
"destination": {
object ( |
Campos | |
---|---|
destination |
El destino en el que se duplicarán las solicitudes. Se ignorará el peso del destino. |
mirrorPercent |
Opcional. Es el porcentaje de solicitudes que se duplicarán en el destino deseado. |
CorsPolicy
La especificación para permitir solicitudes de origen cruzado del cliente.
Representación JSON |
---|
{ "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": string, "allowCredentials": boolean, "disabled": boolean } |
Campos | |
---|---|
allowOrigins[] |
Especifica la lista de orígenes que podrán realizar solicitudes de CORS. Se permite un origen si coincide con un elemento de allowOrigins o con un elemento de allowOriginRegexes. |
allowOriginRegexes[] |
Especifica los patrones de expresión regular que coinciden con los orígenes permitidos. Para obtener información sobre la gramática de las expresiones regulares, consulta https://github.com/google/re2/wiki/Syntax. |
allowMethods[] |
Especifica el contenido del encabezado Access-Control-Allow-Methods. |
allowHeaders[] |
Especifica el contenido del encabezado Access-Control-Allow-Headers. |
exposeHeaders[] |
Especifica el contenido del encabezado Access-Control-Expose-Headers. |
maxAge |
Especifica cuánto tiempo se pueden almacenar en caché los resultados de una solicitud preliminar en segundos. Esto se traduce en el encabezado Access-Control-Max-Age. |
allowCredentials |
En respuesta a una solicitud preliminar, si se configura como verdadero, significa que la solicitud real puede incluir credenciales de usuario. Esto se traduce en el encabezado Access-Control-Allow-Credentials. El valor predeterminado es falso. |
disabled |
Si es verdadero, se inhabilita la política de CORS. El valor predeterminado es "false", lo que indica que la política de CORS está vigente. |
StatefulSessionAffinityPolicy
La especificación para la afinidad de sesión con estado basada en cookies, en la que el plano de datos proporciona una "cookie de sesión" con el nombre "GSSA" que codifica un host de destino específico y cada solicitud que contiene esa cookie se dirigirá a ese host, siempre y cuando el host de destino siga activo y en buen estado.
La biblioteca de malla sin proxy de gRPC o el proxy de sidecar administrarán la cookie de sesión, pero el código de la aplicación cliente es responsable de copiar la cookie de cada RPC de la sesión a la siguiente.
Representación JSON |
---|
{ "cookieTtl": string } |
Campos | |
---|---|
cookieTtl |
Obligatorio. Es el valor de TTL de la cookie para el encabezado Set-Cookie que genera el plano de datos. La duración de la cookie se puede establecer en un valor de 1 a 86,400 segundos (24 horas), inclusive. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
HttpDirectResponse
Es el objeto de respuesta HTTP estático que se mostrará.
Representación JSON |
---|
{ "status": integer, // Union field |
Campos | |
---|---|
status |
Obligatorio. Estado que se mostrará como parte de la respuesta HTTP. Debe ser un número entero positivo. |
Campo de unión HttpBody . Cuerpo que se mostrará como parte de la respuesta HTTP. HttpBody puede ser solo uno de los siguientes: |
|
stringBody |
Opcional. Cuerpo de la respuesta como una cadena. La longitud máxima del cuerpo es de 1,024 caracteres. |
bytesBody |
Opcional. Cuerpo de la respuesta como bytes. El tamaño máximo del cuerpo es de 4,096 B. String codificada en base64. |
Métodos |
|
---|---|
|
Crea una HttpRoute nueva en una ubicación y proyecto determinados. |
|
Borra una sola HttpRoute. |
|
Obtiene detalles de una sola HttpRoute. |
|
Muestra una lista de HttpRoute en una ubicación y proyecto determinados. |
|
Actualiza los parámetros de una sola HttpRoute. |