REST Resource: projects.locations.grpcRoutes

Ressource : GrpcRoute

GrpcRoute est la ressource définissant la manière dont le trafic gRPC acheminé par une ressource de réseau maillé ou de passerelle est acheminé.

Représentation JSON 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "hostnames": [
    string
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "rules": [
    {
      object (RouteRule)
    }
  ]
}
Champs
name

string

Obligatoire. Nom de la ressource GrpcRoute. Il correspond au schéma projects/*/locations/global/grpcRoutes/<grpc_route_name>
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de la ressource.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la mise à jour de la ressource.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Facultatif. Ensemble de tags d'étiquette associés à la ressource GrpcRoute.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Facultatif. Description libre de la ressource. Longueur maximale : 1 024 caractères.
hostnames[]

string

Obligatoire. Noms d'hôte de service avec un port facultatif pour lequel cette route décrit le trafic.

Format: [:]

Le nom d'hôte est le nom de domaine complet d'un hôte réseau. Cela correspond à la définition RFC 1123 d'un nom d'hôte, à deux exceptions notables: - Les adresses IP ne sont pas autorisées. - Un nom d'hôte peut être précédé d'une étiquette générique (*.). L'étiquette générique doit apparaître seule en tant que première étiquette.

Le nom d'hôte peut être "précis", c'est-à-dire un nom de domaine sans le point final d'un hôte réseau (par exemple, foo.example.com) ou "générique", c'est-à-dire un nom de domaine précédé d'un seul libellé générique (par exemple, *.example.com).

Notez que conformément aux normes RFC1035 et RFC1123, une étiquette doit être composée de caractères alphanumériques en minuscules ou de "-", et doit commencer et se terminer par un caractère alphanumérique. Aucun autre signe de ponctuation n'est autorisé.

Les routes associées à un réseau maillé ou à une passerelle doivent avoir des noms d'hôte uniques. Si vous essayez d'associer plusieurs routes avec des noms d'hôte en conflit, la configuration sera refusée.

Par exemple, bien qu'il soit acceptable que les routes soient associées à la même route pour les noms d'hôte *.foo.bar.com et *.bar.com, il n'est pas possible d'associer deux routes à *.bar.com ou les deux à bar.com.

Si un port est spécifié, les clients gRPC doivent utiliser l'URI du canal avec le port correspondant à cette règle (par exemple, "xds:///service:123"), sinon ils doivent fournir l'URI sans port (par exemple, "xds:///service").
meshes[]

string

Facultatif. Les maillages définissent une liste de réseaux maillés auxquels ce GrpcRoute est associé, comme l'une des règles de routage pour acheminer les requêtes diffusées par le maillage.

Chaque référence au maillage doit correspondre au format suivant: projects/*/locations/global/meshes/<mesh_name>
gateways[]

string

Facultatif. Gateways définit la liste des passerelles auxquelles ce GrpcRoute est associé. Il s'agit de l'une des règles de routage permettant d'acheminer les requêtes diffusées par la passerelle.

Chaque référence de passerelle doit respecter le format suivant : projects/*/locations/global/gateways/<gateway_name>
rules[]

object (RouteRule)

Obligatoire. Liste de règles détaillées définissant comment acheminer le trafic.

Dans un seul GrpcRoute, l'action GrpcRoute.RouteAction associée à la première règle GrpcRoute.RouteRule correspondante est exécutée. Vous devez fournir au moins une règle.

RouteRule

Cette page vous explique comment acheminer le trafic.

Représentation JSON 
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
Champs
matches[]

object (RouteMatch)

Facultatif. Les correspondances définissent les conditions utilisées pour faire correspondre la règle aux requêtes gRPC entrantes. Chaque correspondance est indépendante. Autrement dit, cette règle sera appliquée si l'une des correspondances est satisfaite. Si aucun champ de correspondance n'est spécifié, cette règle correspondra inconditionnellement au trafic.
action

object (RouteAction)

Obligatoire. Une règle détaillée définissant comment acheminer le trafic. Ce champ est obligatoire.

RouteMatch

Critères de trafic correspondant. Un RouteMatch est considéré comme correspondant lorsque tous les champs fournis correspondent.

Représentation JSON 
{
  "headers": [
    {
      object (HeaderMatch)
    }
  ],
  "method": {
    object (MethodMatch)
  }
}
Champs
headers[]

object (HeaderMatch)

Facultatif. Spécifie une collection d'en-têtes à faire correspondre.
method

object (MethodMatch)

Facultatif. Méthode gRPC à mettre en correspondance. Si ce champ est vide ou omis, correspondra à toutes les méthodes.

MethodMatch

Spécifie une correspondance avec une méthode.

Représentation JSON 
{
  "type": enum (Type),
  "grpcService": string,
  "grpcMethod": string,
  "caseSensitive": boolean
}
Champs
type

enum (Type)

Facultatif. Indique le type de correspondance avec le nom. Si cette option n'est pas spécifiée, la valeur par défaut "EXACT" est utilisée.
grpcService

string

Obligatoire. Nom du service à mettre en correspondance. S'il n'est pas spécifié, la correspondance est effectuée avec tous les services.
grpcMethod

string

Obligatoire. Nom de la méthode à mettre en correspondance. Si aucune valeur n'est spécifiée, toutes les méthodes sont mises en correspondance.
caseSensitive

boolean

Facultatif. Indique que les correspondances sont sensibles à la casse. La valeur par défaut est "true". La sensibilité à la casse ne doit pas être utilisée avec un type REGULAR_EXPRESSION.

Type

Type de correspondance.

Enums
TYPE_UNSPECIFIED Non spécifié.
EXACT correspondra uniquement au nom exact fourni.
REGULAR_EXPRESSION Interpréte grpcMethod et grpcService comme expressions régulières. La syntaxe RE2 est acceptée.

HeaderMatch

Une correspondance avec une collection d'en-têtes.

Représentation JSON 
{
  "type": enum (Type),
  "key": string,
  "value": string
}
Champs
type

enum (Type)

Facultatif. Spécifie comment effectuer une correspondance avec la valeur de l'en-tête. Si aucune valeur n'est spécifiée, la valeur par défaut EXACT est utilisée.
key

string

Obligatoire. Clé de l'en-tête.
value

string

Obligatoire. Valeur de l'en-tête.

Type

Type de correspondance.

Enums
TYPE_UNSPECIFIED Non spécifié.
EXACT Ne correspond qu'à la valeur exacte fournie.
REGULAR_EXPRESSION Correspond aux chemins conformes au préfixe spécifié par la valeur. La syntaxe RE2 est acceptée.

RouteAction

Indique comment acheminer le trafic correspondant.

Représentation JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "faultInjectionPolicy": {
    object (FaultInjectionPolicy)
  },
  "timeout": string,
  "retryPolicy": {
    object (RetryPolicy)
  },
  "statefulSessionAffinity": {
    object (StatefulSessionAffinityPolicy)
  },
  "idleTimeout": string
}
Champs
destinations[]

object (Destination)

Facultatif. Services de destination auxquels le trafic doit être transféré. Si plusieurs destinations sont spécifiées, le trafic sera réparti entre les services de backend en fonction du champ de pondération de ces destinations.
faultInjectionPolicy

object (FaultInjectionPolicy)

Facultatif. Spécification de l'injection de pannes introduite dans le trafic pour tester la résilience des clients en cas de défaillance du service de destination. Dans le cadre de l'injection de pannes, lorsque les clients envoient des requêtes à une destination, des retards peuvent être appliqués à un pourcentage de requêtes avant de les envoyer au service de destination. De même, un pourcentage de requêtes provenant de clients peut être interrompu.

Le délai d'expiration et l'objet "RetryPolicy" sont ignorés par les clients configurés avec un paramètre faultInjectionPolicy.
timeout

string (Duration format)

Facultatif. Indique le délai avant expiration pour la route sélectionnée. Le délai avant expiration est calculé à partir du moment où la requête a été entièrement traitée (c'est-à-dire, la fin du flux) jusqu'au moment où la réponse a été entièrement traitée. Le délai avant expiration inclut l'ensemble des nouvelles tentatives.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
retryPolicy

object (RetryPolicy)

Facultatif. Spécifie la stratégie de nouvelle tentative associée à cette route.
statefulSessionAffinity

object (StatefulSessionAffinityPolicy)

Facultatif. Spécifie l'affinité de session avec état basée sur les cookies.
idleTimeout

string (Duration format)

Facultatif. Spécifie le délai d'inactivité pour la route sélectionnée. Le délai avant expiration d'inactivité est défini comme la période pendant laquelle aucun octet n'est envoyé ni reçu sur la connexion en amont ou en aval. Si ce paramètre n'est pas défini, le délai avant expiration par défaut est de 1 heure. Si cette valeur est définie sur 0 s, le délai avant expiration est désactivé.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

Destination

Destination vers laquelle le trafic sera acheminé.

Représentation 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
}
Champs
Champ d'union destination_type. Spécifie le type de destination vers lequel le trafic sera acheminé. destination_type ne peut être qu'un des éléments suivants :
serviceName

string

Obligatoire. URL d'un service de destination vers lequel acheminer le trafic. Doit faire référence à un BackendService ou à un ServiceDirectoryService.
weight

integer

Facultatif. Spécifie la proportion de requêtes transférées vers le backend référencé par le champ serviceName. Il est calculé comme suit : - poids/somme des poids de cette liste de destinations. Pour les valeurs non nulles, il peut y avoir un epsilon par rapport à la proportion exacte définie ici, en fonction de la précision prise en charge par une implémentation.

Si un seul serviceName est spécifié et qu'il a une pondération supérieure à 0, 100 % du trafic est transféré vers ce backend.

Si des pondérations sont spécifiées pour un nom de service donné, elles doivent l'être pour tous les noms de service.

Si aucune pondération n'est spécifiée pour tous les services, le trafic est réparti à parts égales entre eux.

FaultInjectionPolicy

Spécification d'injection de pannes introduite dans le trafic pour tester la résilience des clients à l'échec du service de destination. Dans le cadre de l'injection de pannes, lorsque les clients envoient des requêtes à une destination, des retards peuvent être appliqués à un pourcentage de requêtes avant de les envoyer au service de destination. De même, un pourcentage de requêtes provenant de clients peut être interrompu.

Représentation JSON 
{
  "delay": {
    object (Delay)
  },
  "abort": {
    object (Abort)
  }
}
Champs
delay

object (Delay)

Spécification permettant d'injecter un délai aux requêtes client.
abort

object (Abort)

Spécification permettant d'abandonner des requêtes client.

Délai

Spécification du retard des requêtes client dans le cadre de l'injection de pannes avant d'être envoyées à une destination.

Représentation JSON 
{
  "fixedDelay": string,
  "percentage": integer
}
Champs
fixedDelay

string (Duration format)

Spécifiez un délai fixe avant de transmettre la requête.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
percentage

integer

Pourcentage de trafic sur lequel un délai sera injecté.

La valeur doit être comprise entre 0 et 100.

Annuler

Spécification de la manière dont les requêtes client sont interrompues dans le cadre de l'injection de fautes avant d'être envoyées à une destination.

Représentation JSON 
{
  "httpStatus": integer,
  "percentage": integer
}
Champs
httpStatus

integer

Code d'état HTTP utilisé pour interrompre la requête.

La valeur doit être comprise entre 200 et 599 inclus.
percentage

integer

Pourcentage de trafic qui sera abandonné.

La valeur doit être comprise entre [0 et 100]

RetryPolicy

Spécifications des nouvelles tentatives.

Représentation JSON 
{
  "retryConditions": [
    string
  ],
  "numRetries": integer
}
Champs
retryConditions[]

string

  • connect-failure : le routeur réessaiera en cas d'échec de la connexion aux services backend, par exemple en raison d'un délai d'expiration de la connexion.
  • flux refusé: le routeur effectue une nouvelle tentative si le service de backend réinitialise le flux avec un code d'erreur REFUSED_STREAM. Ce type de réinitialisation indique que vous pouvez réessayer sans risque.
  • annulé: le routeur effectue une nouvelle tentative si le code d'état gRPC de l'en-tête de réponse est défini sur "cancelled" [annulée].
  • délai dépassé: le routeur effectuera une nouvelle tentative si le code d'état gRPC de l'en-tête de réponse est défini sur "délai dépassé".
  • ressource épuisée: le routeur effectue une nouvelle tentative si le code d'état gRPC de l'en-tête de réponse est défini sur "épuisé des ressources"
  • indisponible: le routeur réessaiera si le code d'état gRPC de l'en-tête de réponse est défini sur "non disponible".
numRetries

integer (uint32 format)

Spécifie le nombre autorisé de tentatives. Ce nombre doit être > 0. Si aucune valeur n'est spécifiée, la valeur par défaut est 1.

StatefulSessionAffinityPolicy

Spécification de l'affinité de session avec état basée sur les cookies, où le plan de date fournit un "cookie de session" nommé "GSSA" qui encode un hôte de destination spécifique, et chaque requête contenant ce cookie sera dirigée vers cet hôte tant qu'il restera opérationnel.

La bibliothèque de maillage sans proxy gRPC ou le proxy sidecar gèrent le cookie de session, mais le code de l'application cliente est chargé de copier le cookie de chaque RPC de la session à la suivante.

Représentation JSON 
{
  "cookieTtl": string
}
Champs
cookieTtl

string (Duration format)

Obligatoire. Valeur TTL du cookie pour l'en-tête Set-Cookie généré par le plan de données. La durée de vie du cookie peut être comprise entre 1 et 86 400 secondes (24 heures) inclus.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

Méthodes

create

 Crée un GrpcRoute dans un projet et un emplacement donnés.

delete

 Supprime une seule route GrpcRoute.

get

 Récupère les détails d'une seule GrpcRoute.

list

 Répertorie les GrpcRoutes dans un projet et un emplacement donnés.

patch

 Met à jour les paramètres d'une seule GrpcRoute.