REST Resource: projects.locations.gateways

Ressource : Gateway

La ressource Gateway représente la configuration d'un proxy, généralement un équilibreur de charge. Il capture l'adresse IP et le port sur lesquels les services sont exposés par le proxy, ainsi que toutes les configurations de règles. Les routes font référence aux passerelles pour dicter la manière dont les requêtes doivent être acheminé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
  ],
  "allPorts": boolean,
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "allowGlobalAccess": boolean,
  "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 utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) 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 utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) 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 d'étiquette associés à la ressource Gateway.

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

string

Facultatif. Description en texte libre de la ressource. Longueur recommandée : 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 attribué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-65535) 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 à cinq ports. Les passerelles de type "OPEN_MESH" écoutent sur 0.0.0.0 pour IPv4 et :: pour IPv6, et sont compatibles avec plusieurs ports.
allPorts

boolean

Facultatif. Si la valeur est "true", la passerelle écoutera sur tous les ports. Ce champ s'exclut mutuellement avec le champ ports. Ce champ ne s'applique qu'aux passerelles de type "SECURE_WEB_GATEWAY".
scope

string

Facultatif. Le champ d'application détermine la manière dont la configuration de plusieurs instances de passerelle est fusionnée. La configuration de plusieurs instances Gateway avec le même champ d'application sera fusionnée et présentée comme une configuration unique au proxy/équilibreur de charge.

Longueur maximale : 64 caractères. 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'URL ServerTLSPolicy complète. Spécifie comment 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 complète des certificats. Le proxy présente un certificat (sélectionné en fonction de l'indication du nom du serveur) 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 (de la VM au 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 cette SWG est allouée. 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 d'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.
allowGlobalAccess

boolean

Facultatif. Si la valeur est "true", la passerelle autorise le trafic provenant de clients situés en dehors de la région où elle se trouve. Ce champ n'est configurable que 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 la passerelle gérée par le client. Valeurs possibles : * OPEN_MESH * SECURE_WEB_GATEWAY

Enums
TYPE_UNSPECIFIED Le type de 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 pour la passerelle. Valeurs possibles : * 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 pour l'adresse IP version 4.
IPV6 Type pour l'adresse IP version 6.

RoutingMode

Mode de routage de la passerelle, pour déterminer comment elle achemine le trafic. Aujourd'hui, 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 le trafic via la passerelle. Il s'agit du mode de routage par défaut.
NEXT_HOP_ROUTING_MODE Le mode de routage est "prochain saut". Les clients n'ont pas connaissance de la passerelle, et une route (route avancée ou autre type de route) peut être configurée pour diriger le trafic du client vers la passerelle. La passerelle agit ensuite comme un prochain saut 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 détails d'une seule passerelle.

getIamPolicy

 Récupère la stratégie de contrôle des accès d'une ressource.

list

 Liste 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 des accès de la ressource spécifiée.

testIamPermissions

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