REST Resource: projects.locations.gateways

Ressource: Gateway

Gateway stellt die Konfiguration für einen Proxy dar, in der Regel einen Load-Balancer. Er erfasst den ip:port, über den die Dienste vom Proxy verfügbar gemacht werden, zusammen mit allen Richtlinienkonfigurationen. Routen verweisen auf Gateways, um festzulegen, wie Anfragen über dieses Gateway weitergeleitet werden sollen. Nächste ID: 33

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),
  "envoyHeaders": enum (EnvoyHeaders)
}
Felder
name

string

Erforderlich. Name der Gateway-Ressource. Sie entspricht dem Muster projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel für den Zeitpunkt, zu dem die Ressource aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. Satz 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 keine Angabe gemacht wird, wird ein Fehler zurückgegeben.
addresses[]

string

Optional. Null oder eine IPv4- oder IPv6-Adresse, an der das Gateway den Traffic empfängt. Wenn keine Adresse angegeben ist, wird eine IP aus dem Subnetzwerk zugewiesen

Dieses Feld gilt nur für Gateways vom Typ SECURE_WEB_GATEWAY. Gateways vom Typ „OPEN_MESH“ überwachen 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 bindet sich an die angegebenen Ports. Gateways vom Typ „SECURE_WEB_GATEWAY“ sind auf einen Port beschränkt. Gateways vom Typ „OPEN_MESH“ überwachen 0.0.0.0 für IPv4 und :: für IPv6 und unterstützen mehrere Ports.
scope

string

Optional. Der Bereich bestimmt, wie die Konfiguration mehrerer Gateway-Instanzen zusammengeführt wird. Die Konfiguration für mehrere Gateway-Instanzen mit demselben Bereich wird dem Proxy/Load-Balancer als eine einzige Konfiguration angezeigt.

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

string

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

string

Optional. Eine voll qualifizierte Zertifikat-URL-Referenz. Der Proxy zeigt beim Herstellen einer TLS-Verbindung ein (auf SNI ausgewähltes) Zertifikat an. Diese Funktion gilt nur für Gateways des Typs SECURE_WEB_GATEWAY.
gatewaySecurityPolicy

string

Optional. Eine voll qualifizierte GatewaySecurityPolicy-URL-Referenz. Definiert, wie ein Server die Sicherheitsrichtlinie auf eingehende (VM zu Proxy) initiierte Verbindungen anwenden soll.

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

Diese Richtlinie gilt speziell für Gateways des Typs „SECURE_WEB_GATEWAY“.
network

string

Optional. Der relative Ressourcenname, der das VPC-Netzwerk identifiziert, das diese Konfiguration verwendet. Beispiel: projects/*/global/networks/network-1.

Derzeit gilt dieses Feld nur für Gateways vom Typ „SECURE_WEB_GATEWAY“.
subnetwork

string

Optional. Der relative Ressourcenname, der das Subnetzwerk identifiziert, in dem dieser SWG zugewiesen ist. Beispiel: projects/*/regions/us-central1/subnetworks/network-1

Derzeit gilt dieses Feld nur für Gateways vom Typ „SECURE_WEB_GATEWAY“.
ipVersion

enum (IpVersion)

Optional. Die IP-Version, die von diesem Gateway verwendet wird. Gültige Optionen sind IPv4 oder IPv6. Der Standardwert ist IPv4.
envoyHeaders

enum (EnvoyHeaders)

Optional. Legt fest, ob Envoy interne Fehlerbehebungsheader in Upstream-Anfragen einfügt. Andere Envoy-Header können weiterhin eingeschleust werden. Standardmäßig fügt Envoy keine Header zur Fehlerbehebung 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 Arten der IP-Version für das Gateway. Mögliche Werte sind: * IPV4 * IPV6

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

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 die Gateways in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Aktualisiert die Parameter eines einzelnen Gateways.

setIamPolicy

 Legt die Richtlinie für die Zugriffssteuerung für die angegebene Ressource fest.

testIamPermissions

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