REST Resource: projects.locations.gateways

Ressource: Gateway

„Gateway“ steht für die Konfiguration eines Proxys, in der Regel eines Load Balancers. Er erfasst die IP-Adresse und den Port, über die die Dienste vom Proxy verfügbar gemacht werden, sowie alle Richtlinienkonfigurationen. Routen verweisen auf Gateways, um anzugeben, 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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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. 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, unter der das Gateway den Traffic empfängt. Wenn keine Adresse angegeben wird, wird eine IP aus dem Subnetz zugewiesen.

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

integer

Erforderlich. Eine oder mehrere Portnummern (1–65535), über die 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“ hören auf 0.0.0.0 für IPv4 und :: für IPv6 und unterstützen mehrere Ports.
scope

string

Optional. Mit dem Umfang wird festgelegt, wie die Konfiguration mehrerer Gateway-Instanzen zusammengeführt wird. Die Konfiguration mehrerer Gateway-Instanzen mit demselben Umfang wird zusammengeführt und dem Proxy/Load Balancer als einzelne Konfiguration präsentiert.

Maximal 64 Zeichen. Der Umfang muss mit einem Buchstaben beginnen und darf nur Buchstaben, Ziffern und Bindestriche enthalten.
serverTlsPolicy

string

Optional. Eine voll qualifizierte URL-Referenz für ServerTLSPolicy. Gibt an, wie TLS-Traffic beendet wird. Wenn das Feld leer ist, ist die TLS-Terminierung deaktiviert.
certificateUrls[]

string

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

string

Optional. Eine vollständig qualifizierte URL-Referenz für die GatewaySecurityPolicy. Hier wird definiert, wie ein Server die Sicherheitsrichtlinie auf eingehende Verbindungen (VM zu Proxy) anwenden soll.

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

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

string

Optional. Der relative Ressourcenname, der das VPC-Netzwerk angibt, für das diese Konfiguration verwendet wird. Beispiel: projects/*/global/networks/network-1.

Dieses Feld ist derzeit nur für Gateways vom Typ „SECURE_WEB_GATEWAY“ verfügbar.
subnetwork

string

Optional. Der relative Ressourcenname, der das Subnetzwerk angibt, in dem diese 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. Standard 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. Bestimmt, ob Envoy interne Debug-Header in Upstream-Anfragen einfügt. Andere Envoy-Header können weiterhin eingefügt werden. Standardmäßig fügt Envoy keine Debug-Header ein.

Typ

Der Typ des vom Kunden verwalteten Gateways. Mögliche Werte sind: * 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 IP-Versionen des Gateways. Mögliche Werte: * IPV4 * IPV6

Enums
IP_VERSION_UNSPECIFIED Der Typ, wenn keine IP-Version angegeben ist. Standardmäßig ist IPV4 aktiviert.
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 den Traffic weiterleitet. Derzeit gilt dieses Feld nur für Gateways vom Typ 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 Standard-Routing-Modus.
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 so konfiguriert werden, dass der Traffic vom Client zum Gateway weitergeleitet wird. Das Gateway fungiert dann als nächster Hop zum Ziel.

Methoden

create

 Erstellt ein neues Gateway in einem bestimmten Projekt und an einem bestimmten Standort.

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.

setIamPolicy

 Legt die Zugriffskontrollrichtlinie für die angegebene Ressource fest.

testIamPermissions

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