REST Resource: projects.locations.gateways

Recurso: Puerta de enlace

Gateway representa la configuración de un proxy, generalmente un balanceador de cargas. Captura la ip:puerto a través del cual 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
  ],
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "envoyHeaders": enum (EnvoyHeaders)
}
Campos
name

string

Identificador. Es el 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 RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. 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 RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. 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)

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

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

description

string

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 error.

addresses[]

string

Opcional. Cero o una dirección IPv4 o IPv6 en la que la puerta de enlace recibirá el tráfico. Cuando no se proporciona ninguna 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 en :: para IPv6.

ports[]

integer

Obligatorio. Uno o más números de puerto (del 1 al 65535) en los que la puerta de enlace recibirá tráfico. El proxy se vincula a los puertos especificados. Las puertas de enlace de tipo "SECURE_WEB_GATEWAY" se limitan a 1 puerto. Las puertas de enlace de tipo "OPEN_MESH" escuchan en 0.0.0.0 para IPv4 y en :: para IPv6, y admiten varios puertos.

scope

string

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á y se presentará 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 contener letras, números y guiones.

serverTlsPolicy

string

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

certificateUrls[]

string

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

gatewaySecurityPolicy

string

Opcional. Es una referencia de URL completamente calificada a GatewaySecurityPolicy. Define cómo un servidor debe aplicar la política de seguridad a las conexiones iniciadas entrantes (de la VM al 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

Opcional. Es el nombre del 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

Opcional. Es el nombre del recurso relativo que identifica la subred en la que se asigna este 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)

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)

Opcional. Es el modo de enrutamiento de la puerta de enlace. 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.

envoyHeaders

enum (EnvoyHeaders)

Opcional. Determina si Envoy insertará encabezados de depuración internos en las solicitudes ascendentes. Es posible que se sigan insertando 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 Traffic Director 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. La configuración predeterminada es IPV4.
IPV4 Es el tipo para la versión 4 de IP.
IPV6 Es el tipo de la versión 6 de IP.

RoutingMode

Es el modo de enrutamiento de la puerta de enlace, que determina cómo enruta el tráfico. Actualmente, 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 próximo 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 hacia el destino.

Métodos

create

Crea una puerta de enlace nueva en un proyecto y una ubicación determinados.

delete

Borra una sola puerta de enlace.

get

Obtiene los detalles de una sola puerta de enlace.

list

Enumera las puertas de enlace en una ubicación y un proyecto determinados.

patch

Actualiza los parámetros de una sola puerta de enlace.

setIamPolicy

Permite configurar la política de control de acceso en el recurso especificado.

testIamPermissions

Permite mostrar los permisos que tiene un emisor para un recurso especificado.