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 à des passerelles pour déterminer la manière dont les requêtes doivent être acheminées par cette passerelle. Identifiant suivant: 33

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

string

Obligatoire. Nom de la ressource de passerelle. Il correspond au modèle projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Facultatif. Ensemble de tags d'étiquettes 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 en texte 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 aucune valeur n'est spécifiée, 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 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 à un port. Les passerelles de type "OPEN_MESH" écoutent l'IPv4 sur 0.0.0.0 et l'IPv6 sur 0.0.0.0 et acceptent plusieurs ports.
scope

string

Facultatif. Le champ d'application détermine comment la configuration de plusieurs instances de passerelle est fusionnée. La configuration de plusieurs instances de passerelle ayant le même champ d'application sera fusionné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 complète d'une URL ServerTLSPolicy. Spécifie la manière dont le trafic TLS est interrompu. Si ce champ est vide, la terminaison TLS est désactivée.
certificateUrls[]

string

Facultatif. Référence d'URL de certificat complète. Le proxy présente un certificat (sélectionné sur la base de l'extension 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 complète d'une URL GatewaySecurityPolicy. Définit la manière dont un serveur doit appliquer une règle de sécurité aux connexions entrantes (de la VM vers le proxy).

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

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

string

Facultatif. Nom relatif de la ressource 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 auquel 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.
envoyHeaders

enum (EnvoyHeaders)

Facultatif. Détermine si Envoy doit insérer des en-têtes de débogage internes dans les requêtes en amont. D'autres en-têtes Envoy peuvent quand même ê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 La passerelle gérée par le client est de type SecureWebGateway (SWG).

IpVersion

Types de version IP de la passerelle. Les valeurs possibles sont: * 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 la version 4 de l'adresse IP.
IPV6 Type pour la version 6 de l'adresse IP.

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 passerelle unique.

list

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

patch

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