REST Resource: projects.locations.gateways

Recurso: gateway

O Gateway representa a configuração de um proxy, normalmente um equilibrador de carga. Captura o ip:port através do qual os serviços são expostos pelo proxy, juntamente com quaisquer configurações de políticas. As rotas têm referências a gateways para determinar como os pedidos devem ser encaminhados por este gateway.

Representação 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. Nome do recurso de gateway. Corresponde ao padrão projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Apenas saída. A data/hora em que o recurso foi criado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. A data/hora em que o recurso foi atualizado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "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)

Opcional. Conjunto de etiquetas associadas ao recurso Gateway.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Opcional. Uma descrição de texto livre do recurso. Comprimento máximo de 1024 carateres.
type

enum (Type)

Imutável. O tipo de gateway gerido pelo cliente. Este campo é obrigatório. Se não for especificado, é devolvido um erro.
addresses[]

string

Opcional. Zero ou um endereço IPv4 ou IPv6 no qual o gateway vai receber o tráfego. Quando não é fornecido nenhum endereço, é atribuído um IP da sub-rede

Este campo aplica-se apenas a gateways do tipo "SECURE_WEB_GATEWAY". As gateways do tipo "OPEN_MESH" ouvem em 0.0.0.0 para IPv4 e :: para IPv6.
ports[]

integer

Obrigatório. Um ou mais números de porta (1 a 65535) nos quais o gateway recebe tráfego. O proxy é associado às portas especificadas. Os gateways do tipo "SECURE_WEB_GATEWAY" estão limitados a 1 porta. As gateways do tipo "OPEN_MESH" ouvem em 0.0.0.0 para IPv4 e :: para IPv6 e suportam várias portas.
scope

string

Opcional. O âmbito determina como a configuração em várias instâncias do Gateway é unida. A configuração de várias instâncias do Gateway com o mesmo âmbito é unida e apresentada como uma única configuração ao proxy/equilibrador de carga.

Comprimento máximo de 64 carateres. O âmbito deve começar por uma letra e só pode ter letras, números e hífenes.
serverTlsPolicy

string

Opcional. Uma referência de URL ServerTLSPolicy totalmente qualificada. Especifica como o tráfego TLS é terminado. Se estiver vazio, a terminação TLS está desativada.
certificateUrls[]

string

Opcional. Uma referência de URL de certificados totalmente qualificada. O proxy apresenta um certificado (selecionado com base no SNI) quando estabelece uma ligação TLS. Esta funcionalidade aplica-se apenas a gateways do tipo "SECURE_WEB_GATEWAY".
gatewaySecurityPolicy

string

Opcional. Uma referência de URL GatewaySecurityPolicy totalmente qualificada. Define como um servidor deve aplicar a política de segurança a ligações iniciadas de entrada (VM para proxy).

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

Esta política é específica para gateways do tipo "SECURE_WEB_GATEWAY".
network

string

Opcional. O nome do recurso relativo que identifica a rede VPC que está a usar esta configuração. Por exemplo: projects/*/global/networks/network-1.

Atualmente, este campo é específico das gateways do tipo "SECURE_WEB_GATEWAY".
subnetwork

string

Opcional. O nome do recurso relativo que identifica a sub-rede na qual este SWG está atribuído. Por exemplo: projects/*/regions/us-central1/subnetworks/network-1

Atualmente, este campo é específico das gateways do tipo "SECURE_WEB_GATEWAY".
ipVersion

enum (IpVersion)

Opcional. A versão do IP que vai ser usada por este gateway. As opções válidas são IPV4 ou IPV6. A predefinição é IPV4.
routingMode

enum (RoutingMode)

Opcional. O modo de encaminhamento do gateway. Este campo só é configurável para gateways do tipo SECURE_WEB_GATEWAY. Este campo é obrigatório para gateways do tipo SECURE_WEB_GATEWAY.
envoyHeaders

enum (EnvoyHeaders)

Opcional. Determina se o Envoy insere cabeçalhos de depuração internos em pedidos a montante. Outros cabeçalhos do Envoy podem continuar a ser injetados. Por predefinição, o Envoy não insere cabeçalhos de depuração.

Tipo

O tipo de gateway gerido pelo cliente. Os valores possíveis são: * OPEN_MESH * SECURE_WEB_GATEWAY

Enumerações
TYPE_UNSPECIFIED O tipo de gateway gerido pelo cliente não está especificado.
OPEN_MESH O tipo de gateway gerido pelo cliente é o TrafficDirector Open Mesh.
SECURE_WEB_GATEWAY O tipo de gateway gerido pelo cliente é SecureWebGateway (SWG).

IpVersion

Os tipos de versão de IP para o gateway. Os valores possíveis são: * IPV4 * IPV6

Enumerações
IP_VERSION_UNSPECIFIED O tipo quando a versão do IP não é especificada. A predefinição é IPV4.
IPV4 O tipo para a versão 4 do IP.
IPV6 O tipo para a versão 6 do IP.

RoutingMode

O modo de encaminhamento do gateway, para determinar como o gateway encaminha o tráfego. Atualmente, este campo aplica-se apenas a gateways do tipo SECURE_WEB_GATEWAY. Os valores possíveis são: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enumerações
EXPLICIT_ROUTING_MODE O modo de encaminhamento é explícito; os clientes estão configurados para enviar tráfego através do gateway. Este é o modo de encaminhamento predefinido.
NEXT_HOP_ROUTING_MODE O modo de encaminhamento é o próximo salto. Os clientes não têm conhecimento da gateway e é possível configurar uma rota (rota avançada ou outro tipo de rota) para direcionar o tráfego do cliente para a gateway. Em seguida, o gateway funciona como um salto seguinte para o destino.

Métodos

create

 Cria um novo gateway num determinado projeto e localização.

delete

 Elimina um único gateway.

get

 Obtém detalhes de um único Gateway.

list

 Apresenta gateways num determinado projeto e localização.

patch

 Atualiza os parâmetros de um único gateway.

setIamPolicy

 Define a política de controlo de acesso no recurso especificado.

testIamPermissions

 Devolve as autorizações que um autor da chamada tem no recurso especificado.