- Ressource: HttpRoute
- RouteRule
- RouteMatch
- HeaderMatch
- IntegerRange
- QueryParameterMatch
- RouteAction
- Destination
- HeaderModifier
- Redirection
- ResponseCode
- FaultInjectionPolicy
- Retard
- Annuler
- URLRewrite
- RetryPolicy
- RequestMirrorPolicy
- CorsPolicy
- StatefulSessionAffinityPolicy
- HttpDirectResponse
- Méthodes
Ressource : HttpRoute
HttpRoute est la ressource qui définit la manière dont le trafic HTTP doit être acheminé par une ressource de réseau maillé ou de passerelle.
Représentation JSON |
---|
{
"name": string,
"selfLink": string,
"description": string,
"createTime": string,
"updateTime": string,
"hostnames": [
string
],
"meshes": [
string
],
"gateways": [
string
],
"labels": {
string: string,
...
},
"rules": [
{
object ( |
Champs | |
---|---|
name |
Obligatoire. Nom de la ressource HttpRoute. Il correspond au schéma |
selfLink |
Uniquement en sortie. URL définie par le serveur de cette ressource |
description |
Facultatif. Description en texte libre de la ressource. Longueur maximale : 1 024 caractères. |
createTime |
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 : |
updateTime |
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 : |
hostnames[] |
Obligatoire. Les noms d'hôte définissent un ensemble d'hôtes qui doivent correspondre à l'en-tête d'hôte HTTP pour sélectionner une route HTTP afin de traiter la requête. Le nom d'hôte est le nom de domaine complet d'un hôte réseau, tel que défini par la norme RFC 1123, à l'exception des points suivants: - Les adresses IP ne sont pas autorisées. - Un nom d'hôte peut être précédé d'une étiquette générique ( 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, 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 à des passerelles doivent avoir des noms d'hôte uniques. Si vous tentez 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 aux noms d'hôte |
meshes[] |
Facultatif. Les maillages définissent une liste de réseaux maillés auxquels cette route HTTP est associée. Il s'agit de l'une des règles de routage permettant d'acheminer les requêtes diffusées par le maillage. Chaque référence au maillage doit correspondre au format suivant: La structure Mesh associée doit être de type SIDECAR. |
gateways[] |
Facultatif. "Gateways" définit la liste des passerelles auxquelles la passerelle HTTP est associée. Il s'agit de l'une des règles de routage servant à acheminer les requêtes diffusées par la passerelle. Chaque référence de passerelle doit correspondre au format suivant: |
labels |
Facultatif. Ensemble de tags d'étiquette associés à la ressource HttpRoute. Objet contenant une liste de paires |
rules[] |
Obligatoire. Règles qui définissent la manière dont le trafic est acheminé et géré. Les règles sont mises en correspondance de manière séquentielle en fonction de la valeur RouteMatch spécifiée pour la règle. |
RouteRule
Spécifie comment mettre en correspondance le trafic et comment l'acheminer lorsqu'il correspond.
Représentation JSON |
---|
{ "matches": [ { object ( |
Champs | |
---|---|
matches[] |
Une liste de correspondances définit les conditions utilisées pour faire correspondre la règle aux requêtes HTTP 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. Si vous souhaitez configurer une règle par défaut, ajoutez une règle sans correspondance à la fin de la liste de règles. |
action |
Règle détaillée définissant comment acheminer le trafic mis en correspondance. |
RouteMatch
RouteMatch définit les spécifications utilisées pour faire correspondre les requêtes. Si plusieurs types de correspondance sont définis, ce RouteMatch sera mis en correspondance si TOUS les types de correspondances sont mis en correspondance.
Représentation JSON |
---|
{ "ignoreCase": boolean, "headers": [ { object ( |
Champs | |
---|---|
ignoreCase |
Indique si les correspondances prefixMatch et fullPathMatch sont sensibles à la casse. La valeur par défaut est false. |
headers[] |
Spécifie une liste d'en-têtes de requêtes HTTP à mettre en correspondance. TOUS les en-têtes fournis doivent correspondre. |
queryParameters[] |
Spécifie une liste de paramètres de requête à faire correspondre. TOUS les paramètres de requête doivent correspondre. |
Champ d'union
|
|
fullPathMatch |
La valeur du chemin d'accès de la requête HTTP doit correspondre exactement à cette valeur. Vous ne devez utiliser qu'une seule correspondance (fullPathMatch, prefixMatch, ou regexMatch). |
prefixMatch |
La valeur du chemin de la requête HTTP doit commencer par prefixMatch spécifié. préfixeMatch doit commencer par une barre oblique (/). Vous ne devez utiliser qu'une seule des valeurs fullPathMatch, prefixMatch ou regexMatch. |
regexMatch |
La valeur du chemin d'accès de la requête HTTP doit correspondre à l'expression régulière spécifiée par regexMatch après suppression de tous les paramètres de requête et de l'ancre fournis avec l'URL d'origine. Pour en savoir plus sur la grammaire des expressions régulières, consultez la page https://github.com/google/re2/wiki/Syntax. Vous ne devez utiliser qu'une seule correspondance (fullPathMatch, prefixMatch, ou regexMatch). |
HeaderMatch
Spécifie comment sélectionner une règle de routage en fonction des en-têtes de requête HTTP.
Représentation JSON |
---|
{ "header": string, "invertMatch": boolean, // Union field |
Champs | |
---|---|
header |
Nom de l'en-tête HTTP à mettre en correspondance. |
invertMatch |
Si spécifié, le résultat de la correspondance sera inversé avant la vérification. La valeur par défaut est définie sur "false". |
Champ d'union
|
|
exactMatch |
La valeur de l'en-tête doit correspondre exactement au contenu de exactMatch. |
regexMatch |
La valeur de l'en-tête doit correspondre à l'expression régulière spécifiée dans regexMatch. Pour en savoir plus sur la grammaire des expressions régulières, consultez la page https://github.com/google/re2/wiki/Syntax. |
prefixMatch |
La valeur de l'en-tête doit commencer par le contenu de prefixMatch. |
presentMatch |
Un en-tête avec headerName doit exister. La correspondance a lieu que l'en-tête ait une valeur ou non. |
suffixMatch |
La valeur de l'en-tête doit se terminer par le contenu de suffixMatch. |
rangeMatch |
Si elle est spécifiée, la règle correspond si la valeur de l'en-tête de la requête se trouve dans la plage. |
IntegerRange
Représente une plage de valeurs entières.
Représentation JSON |
---|
{ "start": integer, "end": integer } |
Champs | |
---|---|
start |
Début de la plage (inclusif) |
end |
Fin de la plage (exclue) |
QueryParameterMatch
Spécifications permettant de faire correspondre un paramètre de requête dans la requête.
Représentation JSON |
---|
{ "queryParameter": string, // Union field |
Champs | |
---|---|
queryParameter |
Nom du paramètre de requête à faire correspondre. |
Champ d'union
|
|
exactMatch |
La valeur du paramètre de requête doit correspondre exactement au contenu d'exactMatch. Vous ne devez définir qu'un seul élément exactMatch, regexMatch ou presentMatch. |
regexMatch |
La valeur du paramètre de requête doit correspondre à l'expression régulière spécifiée par regexMatch. Pour en savoir plus sur la grammaire des expressions régulières, consultez la page https://github.com/google/re2/wiki/Syntax. Vous ne devez définir qu'un seul type de correspondance "exactMatch", "regexMatch" ou "presentMatch". |
presentMatch |
Indique que QueryParameterMatcher correspond si la requête contient un paramètre de requête, que le paramètre ait une valeur ou non. Vous ne devez définir qu'un seul type de correspondance "exactMatch", "regexMatch" ou "presentMatch". |
RouteAction
Spécifications pour le routage du trafic et l'application des règles associées
Représentation JSON |
---|
{ "destinations": [ { object ( |
Champs | |
---|---|
destinations[] |
Destination à laquelle le trafic doit être transféré. |
redirect |
Si ce champ est défini, la requête est dirigée comme configuré par ce champ. |
faultInjectionPolicy |
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 backend. Dans le cadre de l'injection de pannes, lorsque les clients envoient des requêtes à un service de backend, des retards peuvent être introduits sur un pourcentage de requêtes avant de les envoyer au service de backend. 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. |
requestHeaderModifier |
Spécification permettant de modifier les en-têtes d'une requête correspondante avant la livraison de la requête à la destination. Si des HeaderModifiers sont définis à la fois sur la destination et sur RouteAction, ils seront fusionnés. Les conflits entre les deux ne seront pas résolus au niveau de la configuration. |
responseHeaderModifier |
Spécification permettant de modifier les en-têtes d'une réponse avant de la renvoyer au client. Si des HeaderModifiers sont définis à la fois sur la destination et sur RouteAction, ils seront fusionnés. Les conflits entre les deux ne seront pas résolus au niveau de la configuration. |
urlRewrite |
Spécification de réécriture de l'URL avant transfert des requêtes vers la destination. |
timeout |
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'à ce que la réponse ait é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 " |
retryPolicy |
Indique la stratégie de nouvelle tentative associée à cet itinéraire. |
requestMirrorPolicy |
Spécifie la règle définissant le blocage des requêtes destinées à la destination des routes vers une destination mise en miroir distincte. Le proxy n'attend pas que la destination fantôme réponde avant de renvoyer la réponse. Avant d'envoyer du trafic au service d'ombre, l'en-tête d'hôte/d'autorité est suivi du suffixe "-shadow". |
corsPolicy |
Spécification permettant d'autoriser les requêtes multi-origines côté client. |
statefulSessionAffinity |
Facultatif. Spécifie l'affinité de session avec état basée sur les cookies. |
directResponse |
Facultatif. Objet de réponse HTTP statique à renvoyer quelle que soit la requête. |
idleTimeout |
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 " |
Destination
Spécifications d'une destination vers laquelle la requête doit être acheminée.
Représentation JSON |
---|
{ "serviceName": string, "weight": integer, "requestHeaderModifier": { object ( |
Champs | |
---|---|
serviceName |
URL d'un BackendService vers lequel acheminer le trafic. |
weight |
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 les pondérations ne sont pas spécifiées pour tous les services, le trafic est réparti dans des proportions égales entre tous ces services. |
requestHeaderModifier |
Facultatif. Spécification de la modification des en-têtes d'une requête correspondante avant l'envoi de la requête à la destination. Si des HeaderModifiers sont définis à la fois sur la destination et la RouteAction, ils seront fusionnés. Les conflits entre les deux ne seront pas résolus dans la configuration. |
responseHeaderModifier |
Facultatif. Spécification permettant de modifier les en-têtes d'une réponse avant de la renvoyer au client. Si des HeaderModifiers sont définis à la fois sur la destination et sur RouteAction, ils seront fusionnés. Les conflits entre les deux ne seront pas résolus au niveau de la configuration. |
HeaderModifier
Spécification permettant de modifier l'en-tête HTTP dans les requêtes et les réponses HTTP.
Représentation JSON |
---|
{ "set": { string: string, ... }, "add": { string: string, ... }, "remove": [ string ] } |
Champs | |
---|---|
set |
Remplacez complètement/remplacez les en-têtes par la carte donnée, où la clé est le nom de l'en-tête et la valeur est la valeur de l'en-tête. Objet contenant une liste de paires |
add |
Ajoute les en-têtes avec le mappage donné, où "key" correspond au nom de l'en-tête et "value" à la valeur de l'en-tête. Objet contenant une liste de paires |
remove[] |
Supprimer les en-têtes (correspondant par nom d'en-tête) spécifiés dans la liste. |
Rediriger
Spécification pour la redirection du trafic.
Représentation JSON |
---|
{
"hostRedirect": string,
"pathRedirect": string,
"prefixRewrite": string,
"responseCode": enum ( |
Champs | |
---|---|
hostRedirect |
Hôte qui sera utilisé dans la réponse de redirection au lieu de celui fourni dans la requête. |
pathRedirect |
Chemin d'accès qui sera utilisé dans la réponse de redirection au lieu de celui fourni dans la requête. pathRedirect ne peut pas être fourni avec prefixRedirect. Indiquez-en un seul ou n'en fournissez aucun. Si aucun de ces éléments n'est fourni, le chemin de la requête d'origine est utilisé pour la redirection. |
prefixRewrite |
Indique qu'au cours de la redirection, le préfixe (ou chemin) correspondant doit être remplacé par cette valeur. Cette option permet de créer des URL de manière dynamique en fonction de la requête. |
responseCode |
Code d'état HTTP à utiliser pour la redirection. |
httpsRedirect |
Si cette règle est définie sur "true", le schéma d'URL de la requête redirigée est défini sur https. S'il est défini sur "false", le schéma d'URL de la requête redirigée restera le même que celui de la requête. La valeur par défaut est "false". |
stripQuery |
Si cette règle est définie sur "true", toute partie de requête associée à l'URL d'origine est supprimée avant la redirection de la requête. Si cette valeur est définie sur "false", la partie de la requête de l'URL d'origine est conservée. La valeur par défaut est "false". |
portRedirect |
Port qui sera utilisé dans la requête redirigée au lieu de celui fourni dans la requête. |
ResponseCode
Code de réponse HTTP compatible.
Enums | |
---|---|
RESPONSE_CODE_UNSPECIFIED |
Valeur par défaut |
MOVED_PERMANENTLY_DEFAULT |
Correspond à 301. |
FOUND |
Correspond au code 302. |
SEE_OTHER |
Correspond à 303. |
TEMPORARY_REDIRECT |
Correspond à 307. Dans ce cas, la méthode de requête est conservée. |
PERMANENT_REDIRECT |
Correspond au code 308. Dans ce cas, la méthode de requête est conservée. |
FaultInjectionPolicy
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, le proxy client peut retarder un pourcentage de requêtes avant de les envoyer au service de destination. De même, les requêtes peuvent être annulées par un proxy client pour un certain pourcentage de requêtes.
Représentation JSON |
---|
{ "delay": { object ( |
Champs | |
---|---|
delay |
Spécification permettant d'injecter un délai aux requêtes client. |
abort |
Spécification permettant d'abandonner des requêtes client. |
Délai
Spécification de la façon dont les requêtes client sont retardées dans le cadre de l'injection de fautes avant d'être envoyées à une destination.
Représentation JSON |
---|
{ "fixedDelay": string, "percentage": integer } |
Champs | |
---|---|
fixedDelay |
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 " |
percentage |
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 |
Code d'état HTTP utilisé pour interrompre la requête. La valeur doit être comprise entre 200 et 599 inclus. |
percentage |
Pourcentage de trafic qui sera abandonné. La valeur doit être comprise entre 0 et 100. |
URLRewrite
Spécification pour modifier l'URL de la requête avant de la transférer vers la destination.
Représentation JSON |
---|
{ "pathPrefixRewrite": string, "hostRewrite": string } |
Champs | |
---|---|
pathPrefixRewrite |
Avant le transfert de la requête vers la destination sélectionnée, la partie correspondante du chemin de la requête est remplacée par cette valeur. |
hostRewrite |
Avant de transférer la requête vers la destination sélectionnée, l'en-tête de l'hôte des requêtes est remplacé par cette valeur. |
RetryPolicy
Spécifications des nouvelles tentatives
Représentation JSON |
---|
{ "retryConditions": [ string ], "numRetries": integer, "perTryTimeout": string } |
Champs | |
---|---|
retryConditions[] |
Indique une ou plusieurs conditions lorsque cette stratégie de nouvelle tentative s'applique. Les valeurs valides sont: 5xx: le proxy tentera une nouvelle tentative si le service de destination répond avec un code de réponse 5xx, ou si le service de destination ne répond pas du tout, par exemple: déconnexion, réinitialisation, délai avant expiration de la lecture, échec de connexion et flux refusés. gateway-error : semblable aux codes 5xx, mais ne s'applique qu'aux codes de réponse 502, 503 ou 504. reset : le proxy tente une nouvelle tentative si le service de destination ne répond pas du tout (déconnexion/réinitialisation/délai avant expiration de la lecture) connect-failure: le proxy effectue de nouvelles tentatives en cas d'échec de connexion à la destination, par exemple en raison de l'expiration du délai de connexion. retriable-4xx : le proxy effectuera une nouvelle tentative pour les codes de réponse 4xx récupérables. Actuellement, la seule erreur récupérable prise en charge est 409. refused-stream : le proxy réessayera si la destination réinitialise le flux avec un code d'erreur REFUSED_STREAM. Ce type de réinitialisation indique qu'il est possible de réessayer. |
numRetries |
Spécifie le nombre de tentatives autorisées. Ce nombre doit être > 0. Si aucune valeur n'est spécifiée, la valeur par défaut est 1. |
perTryTimeout |
Spécifie un délai avant expiration non nul par tentative de nouvelle tentative. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
RequestMirrorPolicy
Spécifie la stratégie concernant la mise en miroir des requêtes vers un service de destination distinct. Le proxy n'attend pas les réponses du service fictif. Avant d'envoyer du trafic vers le service fictif, l'en-tête host/authority porte le suffixe -shadow.
Représentation JSON |
---|
{
"destination": {
object ( |
Champs | |
---|---|
destination |
Destination vers laquelle les requêtes seront mises en miroir. La pondération de la destination sera ignorée. |
mirrorPercent |
Facultatif. Pourcentage de requêtes à dupliquer vers la destination souhaitée. |
CorsPolicy
Spécification permettant d'autoriser les requêtes multi-origines côté client.
Représentation JSON |
---|
{ "allowOrigins": [ string ], "allowOriginRegexes": [ string ], "allowMethods": [ string ], "allowHeaders": [ string ], "exposeHeaders": [ string ], "maxAge": string, "allowCredentials": boolean, "disabled": boolean } |
Champs | |
---|---|
allowOrigins[] |
Spécifie la liste des origines qui seront autorisées à envoyer des requêtes CORS. Une origine est autorisée si elle correspond à un élément de "allowOrigins" ou de "allowOriginRegexes". |
allowOriginRegexes[] |
Spécifie les formats d'expression régulière qui correspondent aux origines autorisées. Pour en savoir plus sur la grammaire des expressions régulières, consultez la page https://github.com/google/re2/wiki/Syntax. |
allowMethods[] |
Spécifie le contenu de l'en-tête Access-Control-Allow-Methods. |
allowHeaders[] |
Spécifie le contenu de l'en-tête Access-Control-Allow-Headers. |
exposeHeaders[] |
Spécifie le contenu de l'en-tête Access-Control-Expose-Headers. |
maxAge |
Indique la durée (en secondes) de mise en cache des résultats d'une requête préliminaire. Cela se traduit par l'en-tête Access-Control-Max-Age. |
allowCredentials |
En réponse à une requête préliminaire, définir cette valeur sur "true" indique que la requête réelle peut inclure des identifiants utilisateur. Cela se traduit par l'en-tête Access-Control-Allow-Credentials. La valeur par défaut est Faux (false). |
disabled |
Si la valeur est "true", la règle CORS est désactivée. La valeur par défaut est "false", ce qui indique que la règle CORS est en vigueur. |
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" intitulé "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 que l'hôte de destination reste opérationnel et 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 |
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 " |
HttpDirectResponse
Objet de réponse HTTP statique à renvoyer.
Représentation JSON |
---|
{ "status": integer, // Union field |
Champs | |
---|---|
status |
Obligatoire. État à renvoyer dans la réponse HTTP. Vous devez saisir un entier positif. |
Champ d'union HttpBody . Corps à renvoyer dans la réponse HTTP. HttpBody ne peut être qu'un des éléments suivants : |
|
stringBody |
Facultatif. Corps de la réponse sous forme de chaîne. Le corps ne doit pas dépasser 1 024 caractères. |
bytesBody |
Facultatif. Corps de la réponse en octets. La taille maximale du corps est de 4 096 octets. Chaîne encodée en base64. |
Méthodes |
|
---|---|
|
Crée une route HTTP dans un projet et un emplacement donnés. |
|
Supprime une seule route HttpRoute. |
|
Récupère les informations d'un seul HttpRoute. |
|
Répertorie les HttpRoutes d'un projet et d'un emplacement donnés. |
|
Met à jour les paramètres d'un seul HttpRoute. |