REST Resource: projects.locations.gateways

Ressource: Gateway

Ein Gateway stellt die Konfiguration für einen Proxy dar, in der Regel einen Load-Balancer. Sie enthält die IP-Adresse:den Port, über den die Dienste vom Proxy bereitgestellt werden, sowie alle Richtlinienkonfigurationen. Routen haben einen Verweis auf Gateways, um festzulegen, wie Anfragen von diesem Gateway weitergeleitet werden sollen.

JSON-Darstellung 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "type": enum (Type),
  "addresses": [
    string
  ],
  "ports": [
    integer
  ],
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "envoyHeaders": enum (EnvoyHeaders)
}
Felder
name

string

Kennung. Name der Gateway-Ressource. Sie stimmt mit dem Muster projects/*/locations/*/gateways/<gateway_name> überein.
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 angibt, wann die Ressource aktualisiert 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".
labels

map (key: string, value: string)

Optional. Eine Reihe von Label-Tags, die mit der Gateway-Ressource verknüpft sind.

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

string

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

enum (Type)

Nicht veränderbar. Der Typ des vom Kunden verwalteten Gateways. Dies ist ein Pflichtfeld. Wenn dieses Argument nicht angegeben ist, wird ein Fehler zurückgegeben.
addresses[]

string

Optional. Null oder eine IPv4- oder IPv6-Adresse, über die das Gateway den Traffic empfängt. Wenn keine Adresse angegeben wird, wird eine IP-Adresse aus dem Subnetz zugewiesen.

Dieses Feld gilt nur für Gateways des Typs „SECURE_WEB_GATEWAY“. Gateways vom Typ „OPEN_MESH“ lauschen auf 0.0.0.0 für IPv4 und auf :: für IPv6.
ports[]

integer

Erforderlich. Eine oder mehrere Portnummern (1–65535), auf denen das Gateway Traffic empfängt. Der Proxy wird an die angegebenen Ports gebunden. Gateways vom Typ „SECURE_WEB_GATEWAY“ sind auf einen Port beschränkt. Gateways vom Typ „OPEN_MESH“ lauschen auf 0.0.0.0 für IPv4 und auf :: für IPv6 und unterstützen mehrere Ports.
scope

string

Optional. Der Bereich bestimmt, wie die Konfigurationen mehrerer Gateway-Instanzen zusammengeführt werden. Die Konfiguration für mehrere Gateway-Instanzen mit demselben Bereich wird zusammengeführt und als einzelne Konfiguration für den Proxy/Load-Balancer dargestellt.

Maximale Länge: 64 Zeichen. Der Bereich muss mit einem Buchstaben beginnen und darf nur Buchstaben, Ziffern und Bindestriche enthalten.
serverTlsPolicy

string

Optional. Ein vollständig qualifizierter ServerTLSPolicy-URL-Verweis. Gibt an, wie TLS-Traffic beendet wird. Wenn leer, ist die TLS-Terminierung deaktiviert.
certificateUrls[]

string

Optional. Eine vollständig qualifizierte URL-Referenz für Zertifikate. Der Proxy präsentiert beim Herstellen einer TLS-Verbindung ein Zertifikat, das auf Grundlage von SNI ausgewählt wird. Diese Funktion gilt nur für Gateways vom Typ „SECURE_WEB_GATEWAY“.
gatewaySecurityPolicy

string

Optional. Eine vollständig qualifizierte URL-Referenz für GatewaySecurityPolicy. Definiert, wie ein Server die Sicherheitsrichtlinie auf eingehende Verbindungen anwenden soll, die von der VM zum Proxy initiiert werden.

Beispiel: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

Diese Richtlinie gilt speziell für Gateways vom Typ „SECURE_WEB_GATEWAY“.
network

string

Optional. Der relative Ressourcenname des VPC-Netzwerk, in dem diese Konfiguration verwendet wird. Beispiel: projects/*/global/networks/network-1.

Derzeit ist dieses Feld spezifisch für Gateways vom Typ „SECURE_WEB_GATEWAY“.
subnetwork

string

Optional. Der relative Ressourcenname des Subnetzwerks, in dem dieses SWG zugewiesen ist. Beispiel: projects/*/regions/us-central1/subnetworks/network-1

Derzeit ist dieses Feld nur für Gateways vom Typ „SECURE_WEB_GATEWAY“ verfügbar.
ipVersion

enum (IpVersion)

Optional. Die IP-Version, die von diesem Gateway verwendet wird. Gültige Optionen sind IPV4 oder IPV6. Der Standardwert ist IPV4.
routingMode

enum (RoutingMode)

Optional. Der Routingmodus des Gateways. Dieses Feld kann nur für Gateways vom Typ SECURE_WEB_GATEWAY konfiguriert werden. Dieses Feld ist für Gateways vom Typ SECURE_WEB_GATEWAY erforderlich.
envoyHeaders

enum (EnvoyHeaders)

Optional. Legt fest, ob Envoy interne Debug-Header in Upstream-Anfragen einfügt. Andere Envoy-Header werden möglicherweise weiterhin eingefügt. Standardmäßig fügt Envoy keine Debug-Header ein.

Typ

Der Typ des vom Kunden verwalteten Gateways. Mögliche Werte: * OPEN_MESH * SECURE_WEB_GATEWAY

Enums
TYPE_UNSPECIFIED Der Typ des vom Kunden verwalteten Gateways ist nicht angegeben.
OPEN_MESH Der Typ des vom Kunden verwalteten Gateways ist „TrafficDirector Open Mesh“.
SECURE_WEB_GATEWAY Der Typ des vom Kunden verwalteten Gateways ist „SecureWebGateway“ (SWG).

IpVersion

Die Arten von IP-Versionen für das Gateway. Mögliche Werte: * IPV4 * IPV6

Enums
IP_VERSION_UNSPECIFIED Der Typ, wenn die IP-Version nicht angegeben ist. Die Standardeinstellung ist IPV4.
IPV4 Der Typ für IP-Version 4.
IPV6 Der Typ für IP-Version 6.

RoutingMode

Der Routingmodus des Gateways, um festzulegen, wie das Gateway Traffic weiterleitet. Derzeit gilt dieses Feld nur für Gateways des Typs SECURE_WEB_GATEWAY. Mögliche Werte: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enums
EXPLICIT_ROUTING_MODE Der Routingmodus ist explizit. Clients sind so konfiguriert, dass sie Traffic über das Gateway senden. Dies ist der Standardmodus für das Routing.
NEXT_HOP_ROUTING_MODE Der Routingmodus ist „Next Hop“. Clients sind sich des Gateways nicht bewusst und eine Route (erweiterte Route oder anderer Routentyp) kann konfiguriert werden, um Traffic vom Client zum Gateway weiterzuleiten. Das Gateway fungiert dann als nächster Hop zum Ziel.

Methoden

create

 Erstellt ein neues Gateway in einem angegebenen Projekt und an einem angegebenen Ort.

delete

 Löscht ein einzelnes Gateway.

get

 Ruft Details zu einem einzelnen Gateway ab.

list

 Listet Gateways in einem angegebenen Projekt und an einem angegebenen Standort auf.

patch

 Aktualisiert die Parameter eines einzelnen Gateways.