REST Resource: projects.locations.tlsRoutes

Ressource: TlsRoute

TlsRoute definiert, wie Traffic basierend auf SNI und anderen übereinstimmenden L3-Attributen weitergeleitet werden soll.

JSON-Darstellung
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "rules": [
    {
      object (RouteRule)
    }
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "targetProxies": [
    string
  ],
  "labels": {
    string: string,
    ...
  }
}
Felder
name

string

ID. Name der „TlsRoute“-Ressource. Entspricht dem Muster projects/*/locations/*/tlsRoutes/tls_route_name>.

createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

description

string

Optional. Eine Textbeschreibung der Ressource. Maximale Länge: 1.024 Zeichen.

rules[]

object (RouteRule)

Erforderlich. Regeln, die festlegen, 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[]

string

Optional. „Meshes“ definiert eine Liste von Mesh-Netzwerken, an die diese TlsRoute angehängt ist, als eine der Routingregeln zum Weiterleiten der Anfragen, die vom Mesh-Netzwerk verarbeitet werden.

Jede Mesh-Netzwerk-Referenz muss dem Muster projects/*/locations/*/meshes/<mesh_name> entsprechen.

Das angehängte Mesh-Netzwerk muss vom Typ SIDECAR sein

gateways[]

string

Optional. „Gateways“ definiert eine Liste von Gateways, an die diese TlsRoute angehängt ist, als eine der Routingregeln zum Weiterleiten der vom Gateway verarbeiteten Anfragen.

Jede Gateway-Referenz muss dem Muster projects/*/locations/*/gateways/<gateway_name> entsprechen.

targetProxies[]

string

Optional. „TargetProxies“ definiert eine Liste von TargetTcpProxies, an die diese TlsRoute angehängt ist, als eine der Routingregeln zum Weiterleiten der Anfragen, die vom TargetTcpProxy verarbeitet werden.

Jede TargetTcpProxy-Referenz muss dem Muster projects/*/locations/*/targetTcpProxies/<target_tcp_proxy_name> entsprechen.

labels

map (key: string, value: string)

Optional. Eine Reihe von Label-Tags, die der TlsRoute-Ressource zugeordnet sind.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RouteRule

Gibt an, wie Traffic abgeglichen und wie Traffic weitergeleitet werden soll, wenn Traffic abgeglichen wird.

JSON-Darstellung
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
Felder
matches[]

object (RouteMatch)

Erforderlich. „RouteMatch“ definiert das Prädikat, das zum Abgleichen von Anfragen mit einer bestimmten Aktion verwendet wird. Mehrere Übereinstimmungstypen werden für die Auswertung mit „ODER“ verknüpft. Es muss mindestens ein RouteMatch angegeben werden.

action

object (RouteAction)

Erforderlich. Die detaillierte Regel, die festlegt, wie abgeglichener Traffic weitergeleitet wird.

RouteMatch

„RouteMatch“ definiert das Prädikat, das zum Abgleichen von Anfragen mit einer bestimmten Aktion verwendet wird. Mehrere Übereinstimmungstypen werden für die Auswertung mit „UND“ verknüpft.

JSON-Darstellung
{
  "sniHost": [
    string
  ],
  "alpn": [
    string
  ]
}
Felder
sniHost[]

string

Optional. SNI (Server Name Indication), die abgeglichen werden soll. Die SNI wird mit allen Platzhalterdomains abgeglichen, d. h. www.example.com wird zuerst mit www.example.com, dann mit *.example.com und dann mit *.com. abgeglichen. Teilweise Platzhalter werden nicht unterstützt und Werte wie *w.example.com sind ungültig. Mindestens „sniHost“ oder „alpn“ ist erforderlich. Es können bis zu 100 SNI-Hosts für alle Übereinstimmungen festgelegt werden.

alpn[]

string

Optional. ALPN (Application-Layer Protocol Negotiation), mit der abgeglichen werden soll. Beispiele: „http/1.1“, „h2“. Mindestens „sniHost“ oder „alpn“ ist erforderlich. Es können bis zu 5 ALPNs für alle Übereinstimmungen festgelegt werden.

RouteAction

Die Spezifikationen für das Routing von Traffic und die Anwendung zugehöriger Richtlinien.

JSON-Darstellung
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "idleTimeout": string
}
Felder
destinations[]

object (RouteDestination)

Erforderlich. Die Zieldienste, an die Traffic weitergeleitet werden soll. Mindestens ein Zieldienst ist erforderlich.

idleTimeout

string (Duration format)

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 1 Stunde. 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 „s“. Beispiel: "3.5s".

RouteDestination

Beschreiben Sie das Ziel, an das der Traffic weitergeleitet werden soll.

JSON-Darstellung
{
  "serviceName": string,
  "weight": integer
}
Felder
serviceName

string

Erforderlich. Die URL eines BackendService, an den Traffic weitergeleitet werden soll.

weight

integer

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 Zielen). Die Gewichtungen in allen Zielen müssen nicht 100 ergeben.

Methoden

create

Erstellt eine neue „TlsRoute“ in einem bestimmten Projekt und an einem bestimmten Standort

delete

Löscht eine einzelne „TlsRoute“.

get

Ruft Details zu einer einzelnen „TlsRoute“ ab

list

Listet TlsRoute in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

Aktualisiert die Parameter einer einzelnen „TlsRoute“

setIamPolicy

Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

testIamPermissions

Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.