REST Resource: projects.locations.gateways

Ressource: Gateway

Ein Gateway stellt die Konfiguration für einen Proxy dar, in der Regel einen Load Balancer. Es gibt den IP-Port an, über den die Dienste vom Proxy bereitgestellt werden, sowie alle Richtlinienkonfigurationen. Routen enthalten einen Verweis auf Gateways, um festzulegen, wie Anfragen von diesem 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. Entspricht dem Muster projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der Ressourcenerstellung.

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 der Ressourcenaktualisierung.

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. Die Reihe an 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 Textbeschreibung 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 nicht angegeben, wird ein Fehler zurückgegeben.
addresses[]

string

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

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

integer

Erforderlich. Eine oder mehrere Portnummer(n) (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“ warten für IPv4 auf 0.0.0.0 und für IPv6 auf :: und unterstützen mehrere Ports.
scope

string

Optional. Der Bereich bestimmt, wie die Konfiguration über mehrere Gateway-Instanzen hinweg zusammengeführt wird. Eine Konfiguration für mehrere Gateway-Instanzen mit demselben Bereich wird zusammengeführt und für den Proxy/Load-Balancer als einzelne Konfiguration 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 voll qualifizierter URL-Verweis zur „ServerTLSPolicy“. Gibt an, wie TLS-Traffic terminiert wird. Wenn leer, ist die TLS-Terminierung deaktiviert.
certificateUrls[]

string

Optional. Ein voll qualifizierter URL-Verweis zu Zertifikaten. Der Proxy gibt beim Herstellen einer TLS-Verbindung ein Zertifikat an, das auf Grundlage von SNI ausgewählt wurde. Dieses Feature gilt nur für Gateways vom Typ „SECURE_WEB_GATEWAY“.
gatewaySecurityPolicy

string

Optional. Ein voll qualifizierter URL-Verweis zur „GatewaySecurityPolicy“. Legt fest, wie ein Server die Sicherheitsrichtlinie auf eingehende Verbindungen von der VM zum Proxy anwenden soll.

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

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

string

Optional. Der relative Name der Ressource des VPC-Netzwerks, in dem diese Konfiguration verwendet wird. Beispiel: projects/*/global/networks/network-1.

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

string

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

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

enum (IpVersion)

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

enum (EnvoyHeaders)

Optional. Legt fest, ob Envoy interne Debug-Header in Upstream-Anfragen einfügt. Andere Envoy-Header können weiterhin eingeschleust werden. Envoy fügt standardmäßig 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 wird 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 für das Gateway. Mögliche Werte sind * IPV4 * IPV6.

Enums
IP_VERSION_UNSPECIFIED Keine IP-Version angegeben. Standardmäßig wird IPV4 verwendet.
IPV4 IP-Version 4
IPV6 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 Gateways in einem bestimmten Projekt und an einem bestimmten Standort auf

patch

 Aktualisiert die Parameter eines einzelnen Gateways

setIamPolicy

 Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

testIamPermissions

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