REST Resource: projects.locations.gateways

Ressource: passerelle

La passerelle représente la configuration d'un proxy, généralement un équilibreur de charge. Il capture l'adresse IP:port sur laquelle les services sont exposés par le proxy, ainsi que les configurations de règles. Les routes font référence aux passerelles pour indiquer comment les requêtes doivent être routées par cette passerelle.

Représentation JSON 
{
  "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)
}
Champs
name

string

Identifiant. Nom de la ressource de passerelle. Il correspond au schéma projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de la ressource.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la mise à jour de la ressource.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Facultatif. Ensemble de tags de libellé associés à la ressource de passerelle.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Facultatif. Description libre de la ressource. Longueur maximale : 1 024 caractères.
type

enum (Type)

Immuable. Type de passerelle gérée par le client. Ce champ est obligatoire. Si ce paramètre n'est pas spécifié, une erreur est renvoyée.
addresses[]

string

Facultatif. Zéro ou une adresse IPv4 ou IPv6 sur laquelle la passerelle recevra le trafic. Si aucune adresse n'est fournie, une adresse IP du sous-réseau est allouée.

Ce champ ne s'applique qu'aux passerelles de type "SECURE_WEB_GATEWAY". Les passerelles de type "OPEN_MESH" écoutent sur 0.0.0.0 pour IPv4 et :: pour IPv6.
ports[]

integer

Obligatoire. Un ou plusieurs numéros de port (1 à 65 535), sur lesquels la passerelle recevra le trafic. Le proxy se lie aux ports spécifiés. Les passerelles de type "SECURE_WEB_GATEWAY" sont limitées à un seul port. Les passerelles de type "OPEN_MESH" écoutent sur 0.0.0.0 pour IPv4 et :: pour IPv6, et sont compatibles avec plusieurs ports.
scope

string

Facultatif. Le champ d'application détermine comment la configuration est fusionnée entre plusieurs instances de passerelle. La configuration de plusieurs instances de passerelle ayant la même portée sera fusionnée et présentée comme une seule configuration au proxy/équilibreur de charge.

64 caractères au maximum. Le champ d'application doit commencer par une lettre et ne peut contenir que des lettres, des chiffres et des traits d'union.
serverTlsPolicy

string

Facultatif. Référence d'une URL ServerTLSPolicy complète. Spécifie la manière dont le trafic TLS est arrêté. Si ce champ est vide, la terminaison TLS est désactivée.
certificateUrls[]

string

Facultatif. Référence d'URL de certificats complète. Le proxy présente un certificat (sélectionné en fonction du SNI) lors de l'établissement d'une connexion TLS. Cette fonctionnalité ne s'applique qu'aux passerelles de type "SECURE_WEB_GATEWAY".
gatewaySecurityPolicy

string

Facultatif. Référence d'URL GatewaySecurityPolicy complète. Définit comment un serveur doit appliquer une stratégie de sécurité aux connexions entrantes (VM vers proxy).

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

Cette règle est spécifique aux passerelles de type "SECURE_WEB_GATEWAY".
network

string

Facultatif. Nom de ressource relatif identifiant le réseau VPC qui utilise cette configuration. Exemple : projects/*/global/networks/network-1.

Actuellement, ce champ est spécifique aux passerelles de type "SECURE_WEB_GATEWAY".
subnetwork

string

Facultatif. Nom de ressource relatif identifiant le sous-réseau dans lequel ce SWG est alloué. Par exemple : projects/*/regions/us-central1/subnetworks/network-1

Actuellement, ce champ est spécifique aux passerelles de type "SECURE_WEB_GATEWAY".
ipVersion

enum (IpVersion)

Facultatif. Version IP qui sera utilisée par cette passerelle. Les options valides sont IPV4 ou IPV6. La valeur par défaut est IPV4.
routingMode

enum (RoutingMode)

Facultatif. Mode de routage de la passerelle. Ce champ n'est configurable que pour les passerelles de type SECURE_WEB_GATEWAY. Ce champ est obligatoire pour les passerelles de type SECURE_WEB_GATEWAY.
envoyHeaders

enum (EnvoyHeaders)

Facultatif. Détermine si envoy insère des en-têtes de débogage internes dans les requêtes en amont. D'autres en-têtes Envoy peuvent toujours être injectés. Par défaut, envoy n'insère aucun en-tête de débogage.

Type

Type de passerelle gérée par le client. Les valeurs possibles sont les suivantes: * OPEN_MESH * SECURE_WEB_GATEWAY

Enums
TYPE_UNSPECIFIED Le type de la passerelle gérée par le client n'est pas spécifié.
OPEN_MESH Le type de passerelle gérée par le client est TrafficDirector Open Mesh.
SECURE_WEB_GATEWAY Le type de passerelle gérée par le client est SecureWebGateway (SWG).

IpVersion

Types de version IP de la passerelle. Les valeurs possibles sont les suivantes: * IPV4 * IPV6

Enums
IP_VERSION_UNSPECIFIED Type lorsque la version IP n'est pas spécifiée. La valeur par défaut est IPV4.
IPV4 Type de la version IP 4.
IPV6 Type pour la version 6 du protocole IP.

RoutingMode

Mode de routage de la passerelle, qui détermine la manière dont elle achemine le trafic. À l'heure actuelle, ce champ ne s'applique qu'aux passerelles de type SECURE_WEB_GATEWAY. Valeurs possibles: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enums
EXPLICIT_ROUTING_MODE Le mode de routage est explicite : les clients sont configurés pour envoyer du trafic via la passerelle. Il s'agit du mode de routage par défaut.
NEXT_HOP_ROUTING_MODE Le mode de routage est "next-hop". Les clients ne connaissent pas la passerelle, et un routage (routage avancé ou autre type de routage) peut être configuré pour diriger le trafic du client vers la passerelle. La passerelle agit ensuite comme un saut suivant vers la destination.

Méthodes

create

 Crée une passerelle dans un projet et un emplacement donnés.

delete

 Supprime une seule passerelle.

get

 Récupère les informations d'une seule passerelle.

list

 Répertorie les passerelles d'un projet et d'un emplacement donnés.

patch

 Met à jour les paramètres d'une seule passerelle.

setIamPolicy

 Définit la stratégie de contrôle d'accès de la ressource spécifiée.

testIamPermissions

 Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.