REST Resource: projects.locations.grpcRoutes

Recurso: GrpcRoute

GrpcRoute es el recurso que define cómo se enruta el tráfico de gRPC que se enruta por un recurso de malla o puerta de enlace.

Representación JSON 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "hostnames": [
    string
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "rules": [
    {
      object (RouteRule)
    }
  ]
}
Campos
name

string

Obligatorio. Nombre del recurso GrpcRoute. Coincide con el patrón projects/*/locations/global/grpcRoutes/<grpc_route_name>
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo salida. La 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: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opcional. Conjunto de etiquetas de etiqueta asociadas con el recurso GrpcRoute.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Opcional. Es una descripción de texto libre del recurso. La longitud máxima es de 1,024 caracteres.
hostnames[]

string

Obligatorio. Nombres de host del servicio con un puerto opcional para el que esta ruta describe el tráfico

Formato: [:]

El nombre de host es el nombre de dominio completamente calificado de un host de red. Esto coincide con la definición RFC 1123 de un nombre de host, con 2 excepciones notables: - No se permiten IP. - Un nombre de host puede tener el prefijo de una etiqueta comodín (*.). La etiqueta comodín debe aparecer sola como primera etiqueta.

El nombre de host puede ser “preciso”, que es un nombre de dominio sin el punto final de un host de red (p.ej., foo.example.com), o un “comodín”, que es un nombre de dominio con un prefijo único de una etiqueta de comodín (p.ej., *.example.com).

Ten en cuenta que, según RFC1035 y RFC1123, una etiqueta debe incluir 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 puerta 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 para los nombres de host *.foo.bar.com y *.bar.com se asocien con la misma ruta, no es posible asociar dos rutas con *.bar.com o ambas con bar.com.

Si se especifica un puerto, los clientes de gRPC deben usar el URI del canal con el puerto para que coincida con esta regla (es decir, "xds:///service:123"), de lo contrario, deben proporcionar el URI sin un puerto (es decir, "xds:///service").
meshes[]

string

Opcional. Meshes define una lista de mallas a las que se adjunta este GrpcRoute 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 projects/*/locations/global/meshes/<mesh_name>.
gateways[]

string

Opcional. Las puertas de enlace definen una lista de puertas de enlace a las que se adjunta este GrpcRoute 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 projects/*/locations/global/gateways/<gateway_name>.
rules[]

object (RouteRule)

Obligatorio. Una lista de reglas detalladas que definen cómo enrutar el tráfico.

Dentro de un solo GrpcRoute, se ejecutará el GrpcRoute.RouteAction asociado con el primer GrpcRoute.RouteRule que coincide. Se debe proporcionar al menos una regla.

RouteRule

Describe cómo enrutar el tráfico.

Representación JSON 
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
Campos
matches[]

object (RouteMatch)

Opcional. Las coincidencias definen las condiciones que se usan para hacer coincidir la regla con las solicitudes de gRPC entrantes. Cada coincidencia es independiente, es decir, esta regla coincidirá si se cumple CUALQUIERA de las coincidencias. Si no se especifica un campo de coincidencias, esta regla coincidirá incondicionalmente con el tráfico.
action

object (RouteAction)

Obligatorio. Una regla detallada que define cómo enrutar el tráfico. Este campo es obligatorio.

RouteMatch

Criterios para el tráfico coincidente. Se considerará que una RouteMatch coincide cuando todos los campos proporcionados coinciden.

Representación JSON 
{
  "headers": [
    {
      object (HeaderMatch)
    }
  ],
  "method": {
    object (MethodMatch)
  }
}
Campos
headers[]

object (HeaderMatch)

Opcional. Especifica un conjunto de encabezados que deben coincidir.
method

object (MethodMatch)

Opcional. Un método de gRPC para comparar. Si este campo está vacío o se omite, coincidirá con todos los métodos.

MethodMatch

Especifica una coincidencia con un método.

Representación JSON 
{
  "type": enum (Type),
  "grpcService": string,
  "grpcMethod": string,
  "caseSensitive": boolean
}
Campos
type

enum (Type)

Opcional. Especifica cómo hacer coincidir el nombre. Si no se especifica, se usa el valor predeterminado "EXACT".
grpcService

string

Obligatorio. Nombre del servicio con el que se debe establecer la coincidencia. Si no se especifica, coincidirá con todos los servicios.
grpcMethod

string

Obligatorio. Es el nombre del método con el que se debe establecer la coincidencia. Si no se especifica, coincidirá con todos los métodos.
caseSensitive

boolean

Opcional. Especifica que las coincidencias distinguen mayúsculas de minúsculas. El valor predeterminado es verdadero. La distinción entre mayúsculas y minúsculas no debe usarse con un tipo de REGULAR_ExpressION.

Tipo

Es el tipo de coincidencia.

Enums
TYPE_UNSPECIFIED Sin especificar.
EXACT Solo coincidirá con el nombre exacto proporcionado.
REGULAR_EXPRESSION Se interpretará grpcMethod y grpcService como regex. Se admite la sintaxis RE2.

HeaderMatch

Es una coincidencia con una colección de encabezados.

Representación JSON 
{
  "type": enum (Type),
  "key": string,
  "value": string
}
Campos
type

enum (Type)

Opcional. Especifica cómo hacer coincidir el valor del encabezado. Si no se especifica, se usa un valor predeterminado de EXACT.
key

string

Obligatorio. La clave del encabezado.
value

string

Obligatorio. El valor del encabezado.

Tipo

Es el tipo de coincidencia.

Enums
TYPE_UNSPECIFIED Sin especificar.
EXACT Solo coincidirá con el valor exacto proporcionado.
REGULAR_EXPRESSION Coincide con las rutas de acceso que cumplen con el prefijo especificado por el valor. Se admite la sintaxis RE2.

RouteAction

Especifica cómo enrutar el tráfico coincidente.

Representación JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "faultInjectionPolicy": {
    object (FaultInjectionPolicy)
  },
  "timeout": string,
  "retryPolicy": {
    object (RetryPolicy)
  },
  "statefulSessionAffinity": {
    object (StatefulSessionAffinityPolicy)
  },
  "idleTimeout": string
}
Campos
destinations[]

object (Destination)

Opcional. Los servicios de destino a los que se debe reenviar el tráfico. Si se especifican varios destinos, el tráfico se dividirá entre los servicios de backend según el campo de peso de estos destinos.
faultInjectionPolicy

object (FaultInjectionPolicy)

Opcional. La especificación de la inyección de errores ingresada en el tráfico para probar la resiliencia de los clientes ante la falla del servicio de destino. Como parte de la inyección de errores, cuando los clientes envían solicitudes a un destino, se pueden producir retrasos en un porcentaje de solicitudes antes de enviarlas al servicio de destino. De manera similar, las solicitudes de los clientes pueden anularse para un porcentaje de solicitudes.

Los clientes configurados con failedInjectionPolicy ignorarán timeout yRetryPolicy.
timeout

string (Duration format)

Opcional. 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 “s”. Ejemplo: "3.5s".
retryPolicy

object (RetryPolicy)

Opcional. Especifica la política de reintentos asociada con esta ruta.
statefulSessionAffinity

object (StatefulSessionAffinityPolicy)

Opcional. Especifica la afinidad de sesión con estado basada en cookies.
idleTimeout

string (Duration format)

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 enviaron ni recibieron bytes en la conexión ascendente o descendente. Si no la estableces, el tiempo de espera de inactividad predeterminado será de 1 hora. Si se configura en 0 s, se inhabilitará el tiempo de espera.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

Destino

El destino al que se enrutará el tráfico.

Representación JSON 
{

  // Union field destination_type can be only one of the following:
  "serviceName": string
  // End of list of possible types for union field destination_type.
  "weight": integer
}
Campos
Campo de unión destination_type. Especifica el tipo de destino al que se enrutará el tráfico. destination_type puede ser solo uno de los siguientes:
serviceName

string

Obligatorio. La URL de un servicio de destino al que se enrutará el tráfico. Debe hacer referencia a BackendService o ServiceDirectoryService.
weight

integer

Opcional. Especifica la proporción de solicitudes reenviadas al backend a las que hace referencia el campo serviceName. Esto se calcula de la siguiente manera: - peso/Suma(pesos de esta lista de destino). Para valores distintos de cero, puede haber algo 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 cualquier nombre de servicio, deben especificarse para todos.

Si no se especifican los pesos para todos los servicios, el tráfico se distribuye en proporciones iguales para todos ellos.

FaultInjectionPolicy

La especificación de la inyección de errores ingresada en el tráfico para probar la resiliencia de los clientes ante la falla del servicio de destino. Como parte de la inyección de errores, cuando los clientes envían solicitudes a un destino, se pueden producir retrasos en un porcentaje de solicitudes antes de enviarlas al servicio de destino. De manera similar, las solicitudes de los clientes pueden anularse para un porcentaje de solicitudes.

Representación JSON 
{
  "delay": {
    object (Delay)
  },
  "abort": {
    object (Abort)
  }
}
Campos
delay

object (Delay)

La especificación para insertar retrasos en las solicitudes del cliente.
abort

object (Abort)

Especificación para anular las solicitudes del cliente.

Retraso

Especificación de cómo se retrasan las solicitudes de los clientes como parte de la inserción de errores antes de enviarse a un destino.

Representación JSON 
{
  "fixedDelay": string,
  "percentage": integer
}
Campos
fixedDelay

string (Duration format)

Especifica un retraso fijo antes de reenviar la solicitud.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
percentage

integer

El porcentaje de tráfico en el que se insertará la demora.

El valor debe estar entre [0, 100]

Anular

Especificación de cómo se anulan las solicitudes de los clientes como parte de la inserción de errores antes de enviarse a un destino.

Representación JSON 
{
  "httpStatus": integer,
  "percentage": integer
}
Campos
httpStatus

integer

El código de estado HTTP que se usa para anular la solicitud.

Debe ser un valor entre 200 y 599, ambos incluidos.
percentage

integer

El porcentaje de tráfico que se anulará.

El valor debe estar entre [0, 100]

RetryPolicy

Las especificaciones de los reintentos.

Representación JSON 
{
  "retryConditions": [
    string
  ],
  "numRetries": integer
}
Campos
retryConditions[]

string

  • Connect-fail: el router volverá a intentar conectarse a los servicios de backend, por ejemplo, debido a que se agotó el tiempo de espera de la conexión.
  • rechazada-stream: El router volverá a intentarlo si el servicio de backend restablece la transmisión con un código de error REFLOCATION_STREAM. Este tipo de restablecimiento indica que es seguro volver a intentarlo.
  • cancelado: el router volverá a intentarlo si el código de estado de gRPC en el encabezado de respuesta se configura como cancelado.
  • fecha límite excedida: El router volverá a intentarlo si el código de estado de gRPC en el encabezado de respuesta se estableció como excedido.
  • resource-agotado: El router volverá a intentarlo si el código de estado de gRPC en el encabezado de respuesta se estableció como recursos agotados.
  • no disponible: El router volverá a intentarlo si el código de estado de gRPC en el encabezado de respuesta se establece como no disponible.
numRetries

integer (uint32 format)

Especifica la cantidad permitida de reintentos. Este número debe ser mayor que 0. Si no se especifica, el valor predeterminado es 1.

StatefulSessionAffinityPolicy

La especificación para la afinidad de sesión con estado basada en cookies en la que el plano de fecha proporciona una “cookie de sesión” con el nombre “GSSA” que codifica un host de destino específico y cada solicitud que contenga esa cookie se dirigirá a ese host siempre que el host de destino esté 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

string (Duration format)

Obligatorio. El valor de TTL de las cookies para el encabezado Set-Cookie que genera el plano de datos. La vida útil de la cookie puede establecerse 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 “s”. Ejemplo: "3.5s".

Métodos

create

 Crea un GrpcRoute nuevo en un proyecto y una ubicación determinados.

delete

 Borra un solo GrpcRoute.

get

 Obtiene detalles de un solo GrpcRoute.

list

 Muestra una lista de GrpcRoutes en un proyecto y una ubicación determinados.

patch

 Actualiza los parámetros de un solo GrpcRoute.