REST Resource: projects.locations.tlsRoutes

Ressource : TlsRoute

TlsRoute définit la manière dont le trafic doit être acheminé en fonction du SNI et d'autres attributs de couche 3 correspondants.

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

string

Identifiant. Nom de la ressource TlsRoute. Il correspond au schéma projects/*/locations/global/tlsRoutes/tls_route_name>.

createTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

description

string

Facultatif. Description en texte libre de la ressource. Longueur maximale : 1 024 caractères.

rules[]

object (RouteRule)

Obligatoire. Règles qui définissent la manière dont le trafic est acheminé et géré. Au moins une RouteRule doit être fournie. S'il existe plusieurs règles, l'action effectuée sera celle de la première règle correspondante.

meshes[]

string

Facultatif. "meshes" définit la liste des mailles auxquelles cette TlsRoute est associée, en tant que l'une des règles de routage permettant de router les requêtes traitées par la maille.

Chaque référence de maillage doit correspondre au modèle suivant : projects/*/locations/global/meshes/<mesh_name>

Le maillage associé doit être de type SIDECAR.

gateways[]

string

Facultatif. "gateways" définit la liste des passerelles auxquelles cette TlsRoute est associée, en tant que l'une des règles de routage permettant de router les requêtes traitées par la passerelle.

Chaque référence de passerelle doit correspondre au modèle suivant : projects/*/locations/global/gateways/<gateway_name>

labels

map (key: string, value: string)

Facultatif. Ensemble de tags de libellé associés à la ressource TlsRoute.

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

RouteRule

Indique comment faire correspondre le trafic et comment l'acheminer lorsqu'il correspond.

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

object (RouteMatch)

Obligatoire. RouteMatch définit le prédicat utilisé pour faire correspondre les requêtes à une action donnée. Plusieurs types de correspondance sont combinés avec un "OU" pour l'évaluation. Vous devez fournir au moins un RouteMatch.

action

object (RouteAction)

Obligatoire. Règle détaillée définissant comment acheminer le trafic correspondant.

RouteMatch

RouteMatch définit le prédicat utilisé pour faire correspondre les requêtes à une action donnée. Plusieurs types de correspondance sont combinés avec un "AND" pour l'évaluation.

Représentation JSON
{
  "sniHost": [
    string
  ],
  "alpn": [
    string
  ]
}
Champs
sniHost[]

string

Facultatif. SNI (indicateur de nom de serveur) à comparer. Le SNI sera mis en correspondance avec tous les domaines génériques. Par exemple, www.example.com sera d'abord mis en correspondance avec www.example.com, puis avec *.example.com, puis avec *.com.. Les caractères génériques partiels ne sont pas acceptés. Les valeurs telles que *w.example.com ne sont pas valides. Au moins l'un des champs sniHost et alpn est obligatoire. Vous pouvez définir jusqu'à 100 organisateurs de snippets pour l'ensemble des matchs.

alpn[]

string

Facultatif. ALPN (Application-Layer Protocol Negotiation) à comparer. Exemples : "http/1.1", "h2". Au moins l'un des champs sniHost et alpn est obligatoire. Vous pouvez définir jusqu'à cinq ALPN pour toutes les correspondances.

RouteAction

Spécifications pour le routage du trafic et l'application des règles associées.

Représentation JSON
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "idleTimeout": string
}
Champs
destinations[]

object (RouteDestination)

Obligatoire. Services de destination vers lesquels le trafic doit être transféré. Vous devez indiquer au moins un service de destination.

idleTimeout

string (Duration format)

Facultatif. Indique le délai d'inactivité pour la route sélectionnée. Le délai 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 d'inactivité par défaut est d'une heure. Si la 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"

RouteDestination

Décrivez la destination vers laquelle le trafic doit être acheminé.

Représentation JSON
{
  "serviceName": string,
  "weight": integer
}
Champs
serviceName

string

Obligatoire. URL d'un BackendService vers lequel le trafic doit être acheminé.

weight

integer

Facultatif. Spécifie la proportion de requêtes transférées au backend référencé par le champ "serviceName". Elle est calculée comme suit : - pondération/Somme(pondérations dans les destinations). La somme des pondérations dans toutes les destinations ne doit pas nécessairement être égale à 100.

Méthodes

create

Crée une route TLS dans un projet et un emplacement donnés.

delete

Supprime une seule TlsRoute.

get

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

list

Répertorie les TlsRoute d'un projet et d'un emplacement donnés.

patch

Mettre à jour les paramètres d'un seul objet TlsRoute.