REST Resource: projects.locations.gateways

Recurso: Puerta de enlace

La puerta de enlace representa la configuración de un proxy, que suele ser un balanceador de cargas. Captura el puerto IP sobre el que el proxy expone los servicios, junto con cualquier configuración de política. Las rutas hacen referencia a las puertas de enlace para indicar cómo esta debe enrutar las solicitudes. Siguiente ID: 33

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

string

Obligatorio. Nombre del recurso de puerta de enlace. Coincide con el patrón projects/*/locations/*/gateways/<gateway_name>.

createTime

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Opcional. Es un conjunto de etiquetas asociadas con el recurso de puerta de enlace.

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 del recurso en formato de texto libre. Longitud máxima: 1,024 caracteres.

type

enum (Type)

Inmutable. 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 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 (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 :: para IPv6, y admiten varios puertos.

scope

string

Opcional. El permiso determina cómo se combina la configuración en varias instancias de Gateway. La configuración de varias instancias de puerta de enlace 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

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

certificateUrls[]

string

Opcional. Es una referencia completa para URLs de certificados. El proxy presenta un certificado (seleccionado en función de 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

Opcional. Una referencia de URL de GatewaySecurityPolicy completamente calificada. Define cómo un servidor debe aplicar la política de seguridad a las conexiones entrantes (de VM a proxy) que se inician.

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

Esta política es específica de las puertas de enlace de tipo "SECURE_WEB_GATEWAY".

network

string

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 de las puertas de enlace de tipo "SECURE_WEB_GATEWAY".

subnetwork

string

Opcional. 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. La versión de IP que usará esta puerta de enlace. Las opciones válidas son IPV4 o IPV6. El valor predeterminado es IPV4.

envoyHeaders

enum (EnvoyHeaders)

Opcional. Determina si Envoy insertará encabezados de depuración internos en las solicitudes upstream. Es posible que aún se inserten 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 especifica el tipo de puerta de enlace administrada por el cliente.
OPEN_MESH El tipo de puerta de enlace administrada por el cliente es Open Mesh de TrafficDirector.
SECURE_WEB_GATEWAY El tipo de puerta de enlace administrada por el cliente es SecureWebGateway (SWG).

IpVersion

Los tipos de versión de IP para la puerta de enlace. Los valores posibles son los siguientes: * 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 de la versión 4 de IP.
IPV6 Es el tipo de la versión 6 de IP.

Métodos

create

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

delete

Borra una sola puerta de enlace.

get

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