Ressource: TcpRoute
„TcpRoute“ ist die Ressource, die definiert, wie TCP-Traffic von einer Mesh- oder Gateway-Ressource weitergeleitet werden soll.
| JSON-Darstellung |
|---|
{
"name": string,
"selfLink": string,
"createTime": string,
"updateTime": string,
"description": string,
"rules": [
{
object ( |
| Felder | |
|---|---|
name |
ID. Name der „TcpRoute“-Ressource. Entspricht dem Muster |
selfLink |
Nur Ausgabe. Serverdefinierte URL dieser Ressource |
createTime |
Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource erstellt wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
updateTime |
Nur Ausgabe. Der Zeitstempel der Ressourcenaktualisierung. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
description |
Optional. Eine Textbeschreibung der Ressource. Maximale Länge: 1.024 Zeichen. |
rules[] |
Erforderlich. Regeln, die definieren, wie Traffic weitergeleitet und verarbeitet wird. Es muss mindestens eine RouteRule angegeben werden. Wenn mehrere Regeln vorhanden sind, wird die Aktion der ersten übereinstimmenden Regel ausgeführt. |
meshes[] |
Optional. „Meshes“ definiert eine Liste von Mesh-Netzwerken, an die diese TcpRoute angehängt ist, als eine der Routingregeln zum Weiterleiten der Anfragen, die vom Mesh-Netzwerk verarbeitet werden. Jede Mesh-Netzwerk-Referenz muss dem Muster entsprechen: Das angehängte Mesh-Netzwerk muss vom Typ SIDECAR sein. |
gateways[] |
Optional. „Gateways“ definiert eine Liste von Gateways, an die diese TcpRoute angehängt ist, als eine der Routingregeln zum Weiterleiten der vom Gateway verarbeiteten Anfragen. Jede Gateway-Referenz muss dem Muster entsprechen: |
labels |
Optional. Eine Reihe von Label-Tags, die der TcpRoute-Ressource zugeordnet sind. Ein Objekt, das eine Liste von |
RouteRule
Gibt an, wie Traffic abgeglichen und weitergeleitet werden soll, wenn er abgeglichen wird.
| JSON-Darstellung |
|---|
{ "matches": [ { object ( |
| Felder | |
|---|---|
matches[] |
Optional. „RouteMatch“ definiert das Prädikat, das verwendet wird, um Anfragen mit einer bestimmten Aktion abzugleichen. Mehrere Abgleichstypen werden für die Auswertung mit „OR“ verknüpft. Wenn kein „routeMatch“-Feld angegeben ist, wird diese Regel immer auf Traffic angewendet. |
action |
Erforderlich. Die detaillierte Regel, die definiert, wie abgeglichener Traffic weitergeleitet werden soll. |
RouteMatch
„RouteMatch“ definiert das Prädikat, das verwendet wird, um Anfragen mit einer bestimmten Aktion abzugleichen. Mehrere Abgleichstypen werden für die Auswertung mit „OR“ verknüpft. Wenn kein „routeMatch“-Feld angegeben ist, wird diese Regel immer auf Traffic angewendet.
| JSON-Darstellung |
|---|
{ "address": string, "port": string } |
| Felder | |
|---|---|
address |
Erforderlich. Muss im CIDR-Bereichsformat angegeben werden. Ein CIDR-Bereich besteht aus einer IP-Adresse und einer Präfixlänge, um die Subnetzmaske zu erstellen. Standardmäßig ist die Präfixlänge 32 (d.h. sie stimmt mit einer einzelnen IP-Adresse überein). Nur IPv4-Adressen werden unterstützt. Beispiele: „10.0.0.1“ – stimmt mit dieser genauen IP-Adresse überein. „10.0.0.0/8“ – stimmt mit jeder IP-Adresse im Subnetz 10.0.0.0 und der Maske 255.255.255.0 überein. „0.0.0.0/0“ – stimmt mit jeder IP-Adresse überein. |
port |
Erforderlich. Gibt den Zielport an, mit dem abgeglichen werden soll. |
RouteAction
Die Spezifikationen für das Weiterleiten von Traffic und das Anwenden zugehöriger Richtlinien.
| JSON-Darstellung |
|---|
{
"destinations": [
{
object ( |
| Felder | |
|---|---|
destinations[] |
Optional. Die Zieldienste, an die Traffic weitergeleitet werden soll. Mindestens ein Zieldienst ist erforderlich. Es kann nur eines der beiden Ziele festgelegt werden: Routenziel oder ursprüngliches Ziel. |
originalDestination |
Optional. Wenn „true“, verwendet der Router die Ziel-IP und den Zielport der ursprünglichen Verbindung als Ziel der Anfrage. Der Standardwert ist „false“. Es kann nur eines der beiden Ziele festgelegt werden: Routenziel oder ursprüngliches Ziel. |
idleTimeout |
Optional. Gibt das Zeitlimit für die ausgewählte Route an. Das Leerlauf-Zeitlimit wird als der Zeitraum definiert, in dem weder in der Upstream- noch in der Downstream-Verbindung Bytes gesendet oder empfangen werden. Wenn nicht festgelegt, beträgt das standardmäßige Leerlauf-Zeitlimit 30 Sekunden. Wenn der Wert auf „0 s“ gesetzt ist, wird das Zeitlimit deaktiviert. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
RouteDestination
Beschreibt das Ziel, an das Traffic weitergeleitet werden soll.
| JSON-Darstellung |
|---|
{ "serviceName": string, "weight": integer } |
| Felder | |
|---|---|
serviceName |
Erforderlich. Die URL eines BackendService, an den Traffic weitergeleitet werden soll. |
weight |
Optional. Gibt den Anteil der Anfragen an, die an das Backend weitergeleitet werden, auf das im Feld „serviceName“ verwiesen wird. Der Wert wird so berechnet: – Gewichtung/Summe(Gewichtungen in dieser Zielliste). Bei Werten ungleich null kann es je nach Precision, die eine Implementierung unterstützt, zu Abweichungen vom hier definierten genauen Anteil kommen. Wenn nur ein serviceName angegeben ist und dieser eine Gewichtung von mehr als 0 hat, wird 100 % des Traffics an dieses Backend weitergeleitet. Wenn Gewichtungen für einen Dienstnamen angegeben werden, müssen sie für alle angegeben werden. Wenn für alle Dienste keine Gewichtungen angegeben sind, wird der Traffic gleichmäßig auf alle verteilt. |
Methoden |
|
|---|---|
|
Erstellt eine neue „TcpRoute“ in einem bestimmten Projekt und an einem bestimmten Standort. |
|
Löscht eine einzelne „TcpRoute“. |
|
Ruft Details zu einer einzelnen „TcpRoute“ ab. |
|
Listet „TcpRoute“ in einem bestimmten Projekt und an einem bestimmten Standort auf. |
|
Aktualisiert die Parameter einer einzelnen „TcpRoute“ |
|
Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest. |
|
Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück. |