REST Resource: projects.locations.gateways

Recurso: Gateway

O gateway representa a configuração de um proxy, geralmente um balanceador de carga. Ele captura o ip:porta em que os serviços são expostos pelo proxy, além de todas as configurações de política. As rotas têm referência a gateways para determinar como as solicitações devem ser encaminhadas por esse 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. Ele corresponde ao padrão projects/*/locations/*/gateways/<gateway_name>.
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o recurso foi criado.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "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. O carimbo de data/hora em que o recurso foi atualizado.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "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 tags de rótulo associadas ao recurso "Gateway".

Um objeto com 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 1.024 caracteres.
type

enum (Type)

Imutável. O tipo de gateway gerenciado pelo cliente. Este campo é obrigatório. Caso o valor não seja especificado, um erro vai ser retornado.
addresses[]

string

Opcional. Zero ou um endereço IPv4 ou IPv6 em que o gateway vai receber o tráfego. Quando nenhum endereço é fornecido, um IP da sub-rede é alocado.

Esse campo só se aplica a gateways do tipo "SECURE_WEB_GATEWAY". Gateways do tipo "OPEN_MESH" escutam em 0.0.0.0 para IPv4 e :: para IPv6.
ports[]

integer

Obrigatório. Um ou mais números de porta (1 a 65535) em que o gateway vai receber tráfego. O proxy se vincula às portas especificadas. Os gateways do tipo "SECURE_WEB_GATEWAY" são limitados a uma porta. Gateways do tipo "OPEN_MESH" detectam 0.0.0.0 para IPv4 e :: para IPv6 e são compatíveis com várias portas.
scope

string

Opcional. O escopo determina como a configuração em várias instâncias do gateway é mesclada. A configuração de várias instâncias de gateway com o mesmo escopo será mesclada e apresentada como uma única configuração para o proxy/balanceador de carga.

Tamanho máximo de 64 caracteres. O escopo precisa começar com uma letra e só pode ter letras, números e hífens.
serverTlsPolicy

string

Opcional. Uma referência de URL ServerTLSPolicy totalmente qualificada. Especifica como o tráfego TLS é encerrado. Se estiver vazio, o término de TLS será desativado.
certificateUrls[]

string

Opcional. Uma referência de URL de certificados totalmente qualificada. O proxy apresenta um certificado (selecionado com base no SNI) ao estabelecer uma conexão TLS. Esse recurso se aplica apenas a gateways do tipo "SECURE_WEB_GATEWAY".
gatewaySecurityPolicy

string

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

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

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

string

Opcional. O nome de recurso relativo que identifica a rede VPC que está usando essa configuração. Por exemplo, projects/*/global/networks/network-1.

No momento, esse campo é específico para gateways do tipo "SECURE_WEB_GATEWAY".
subnetwork

string

Opcional. O nome do recurso relativo que identifica a sub-rede em que o SWG está alocado. Por exemplo: projects/*/regions/us-central1/subnetworks/network-1

No momento, esse campo é específico para gateways do tipo "SECURE_WEB_GATEWAY".
ipVersion

enum (IpVersion)

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

enum (RoutingMode)

Opcional. O modo de roteamento do gateway. Esse campo só pode ser configurado 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 vai inserir cabeçalhos de depuração internos em solicitações upstream. Outros cabeçalhos do Envoy ainda podem ser injetados. Por padrão, o Envoy não insere cabeçalhos de depuração.

Tipo

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

Enums
TYPE_UNSPECIFIED O tipo de gateway gerenciado pelo cliente não foi especificado.
OPEN_MESH O tipo de gateway gerenciado pelo cliente é "Malha aberta do Traffic Director".
SECURE_WEB_GATEWAY O tipo de gateway gerenciado pelo cliente é SecureWebGateway (SWG).

IpVersion

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

Enums
IP_VERSION_UNSPECIFIED O tipo quando a versão do IP não é especificada. O padrão é IPV4.
IPV4 O tipo da versão 4 do IP.
IPV6 O tipo para a versão 6 do IP.

RoutingMode

O modo de roteamento do gateway para determinar como ele roteia o tráfego. Hoje, esse campo só se aplica a gateways do tipo SECURE_WEB_GATEWAY. Os valores possíveis são: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

Enums
EXPLICIT_ROUTING_MODE O modo de roteamento é explícito. Os clientes são configurados para enviar tráfego pelo gateway. Esse é o modo de roteamento padrão.
NEXT_HOP_ROUTING_MODE O modo de roteamento é de próximo salto. Os clientes não conhecem o gateway, e uma rota (avançada ou de outro tipo) pode ser configurada para direcionar o tráfego do cliente para o gateway. Em seguida, o gateway atua como um próximo salto para o destino.

Métodos

create

 Cria um novo gateway em um determinado projeto e local.

delete

 Exclui um único gateway.

get

 Recebe detalhes de um único gateway.

list

 Lista gateways em um determinado projeto e local.

patch

 Atualiza os parâmetros de um único gateway.

setIamPolicy

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

testIamPermissions

 Retorna permissões do autor da chamada no recurso especificado.