REST Resource: projects.locations.gateways

Recurso: Gateway

Gateway representa la configuración de un proxy, por lo general, un balanceador de cargas. Captura la ip:port sobre la que el proxy expone los servicios, junto con cualquier configuración de política. Las rutas hacen referencia a las Gateways para indicar cómo esta Gateway debe enrutar las solicitudes.

Representación 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)
}
Campos
name

string

Es el identificador. Nombre del recurso de Gateway. Coincide con el patrón projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Solo salida. Marca de tiempo cuando se creó el recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. La marca de tiempo cuando se creó el recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Es opcional. Es un conjunto de etiquetas asociadas con el recurso de Gateway.

Un objeto que contiene una lista de "key": value pares. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Es opcional. Es una descripción de texto libre del recurso. La longitud máxima es de 1,024 caracteres.
type

enum (Type)

Inmutable. Es el tipo de puerta de enlace administrada por el cliente. Este campo es obligatorio. Si no se especifica, se muestra un mensaje de error.
addresses[]

string

Es opcional. Cero o una dirección IPv4 o IPv6 en la que la Gateway recibirá el tráfico. Cuando no se proporciona una dirección, se asigna una IP de la subred.

Este campo solo se aplica a las puertas de enlace de tipo “SECURE_WEB_GATEWAY”. Las puertas de enlace de tipo “OPEN_MESH” escuchan en 0.0.0.0 para IPv4 y :: para IPv6.
ports[]

integer

Obligatorio. Uno o más números de puerto (1-65535), en los que la Gateway recibirá tráfico. El proxy se vincula a los puertos especificados. Las puertas de enlace de tipo “SECURE_WEB_GATEWAY” están limitadas a 5 puertos. Las puertas de enlace de tipo “OPEN_MESH” escuchan en 0.0.0.0 para IPv4 y :: para IPv6, y admiten varios puertos.
allPorts

boolean

Es opcional. Si es verdadero, la Gateway escuchará en todos los puertos. Esto es mutuamente exclusivo con el campo ports. Este campo solo se aplica a las puertas de enlace de tipo “SECURE_WEB_GATEWAY”.
scope

string

Es opcional. El alcance determina cómo se combina la configuración en varias instancias de Gateway. La configuración de varias instancias de Gateway con el mismo alcance se combinará como una sola configuración para el proxy o el balanceador de cargas.

La longitud máxima es de 64 caracteres. El alcance debe comenzar con una letra y solo puede tener letras, números y guiones.
serverTlsPolicy

string

Es opcional. Es una referencia de URL de ServerTLSPolicy completamente calificada. Especifica cómo finaliza el tráfico de TLS. Si está vacío, se inhabilita la finalización de TLS.
certificateUrls[]

string

Es opcional. Es una referencia de URL de Certificates completamente calificada. El proxy presenta un certificado (seleccionado según SNI) cuando establece una conexión TLS. Esta función solo se aplica a las puertas de enlace de tipo “SECURE_WEB_GATEWAY”.
gatewaySecurityPolicy

string

Es opcional. Es una referencia de URL de GatewaySecurityPolicy completamente calificada. Define cómo un servidor debe aplicar la política de seguridad a las conexiones iniciadas entrantes (de VM a proxy).

Por ejemplo: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

Esta política es específica para las puertas de enlace de tipo “SECURE_WEB_GATEWAY”.
network

string

Es opcional. Es el nombre de recurso relativo que identifica la red de VPC que usa esta configuración. Por ejemplo: projects/*/global/networks/network-1.

Actualmente, este campo es específico para las puertas de enlace de tipo “SECURE_WEB_GATEWAY”.
subnetwork

string

Es opcional. Es el nombre de recurso relativo que identifica la subred en la que se asigna esta SWG. Por ejemplo: projects/*/regions/us-central1/subnetworks/network-1.

Actualmente, este campo es específico para las puertas de enlace de tipo “SECURE_WEB_GATEWAY”.
ipVersion

enum (IpVersion)

Es opcional. Es la versión de IP que usará esta puerta de enlace. Las opciones válidas son IPV4 o IPV6. El valor predeterminado es IPV4.
routingMode

enum (RoutingMode)

Es opcional. Es el modo de enrutamiento de la Gateway. Este campo solo se puede configurar para las puertas de enlace de tipo SECURE_WEB_GATEWAY. Este campo es obligatorio para las puertas de enlace de tipo SECURE_WEB_GATEWAY.
allowGlobalAccess

boolean

Es opcional. Si es verdadero, la puerta de enlace permitirá el tráfico de clientes fuera de la región en la que se encuentra la puerta de enlace. Este campo solo se puede configurar para las puertas de enlace de tipo SECURE_WEB_GATEWAY.
envoyHeaders

enum (EnvoyHeaders)

Es opcional. Determina si Envoy insertará encabezados de depuración internos en las solicitudes ascendentes. Es posible que se inyecten otros encabezados de Envoy. De forma predeterminada, Envoy no insertará ningún encabezado de depuración.

Tipo

Es el tipo de puerta de enlace administrada por el cliente. Los valores posibles son: * OPEN_MESH * SECURE_WEB_GATEWAY

Enums
TYPE_UNSPECIFIED No se especificó el tipo de puerta de enlace administrada por el cliente.
OPEN_MESH El tipo de puerta de enlace administrada por el cliente es TrafficDirector Open Mesh.
SECURE_WEB_GATEWAY El tipo de puerta de enlace administrada por el cliente es SecureWebGateway (SWG).

IpVersion

Son los tipos de versión de IP para la puerta de enlace. Los valores posibles son: * IPV4 * IPV6

Enums
IP_VERSION_UNSPECIFIED Es el tipo cuando no se especifica la versión de IP. El valor predeterminado es IPV4.
IPV4 Es el tipo para la versión 4 de IP.
IPV6 Es el tipo para la versión 6 de IP.

RoutingMode

Es el modo de enrutamiento de la Gateway para determinar cómo la Gateway enruta el tráfico. Hoy en día, este campo solo se aplica a las Gateways de tipo SECURE_WEB_GATEWAY. Los valores posibles son: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enums
EXPLICIT_ROUTING_MODE El modo de enrutamiento es explícito; los clientes están configurados para enviar tráfico a través de la puerta de enlace. Este es el modo de enrutamiento predeterminado.
NEXT_HOP_ROUTING_MODE El modo de enrutamiento es de siguiente salto. Los clientes no conocen la puerta de enlace y se puede configurar una ruta (ruta avanzada o de otro tipo) para dirigir el tráfico del cliente a la puerta de enlace. Luego, la puerta de enlace actúa como un siguiente salto al destino.

Métodos

create

 Crea una Gateway nueva en un proyecto y una ubicación determinados.

delete

 Borra una sola Gateway.

get

 Obtiene detalles de una sola Gateway.

list

 Enumera las Gateways en un proyecto y una ubicación determinados.

patch

 Actualiza los parámetros de una sola Gateway.