REST Resource: projects.locations.gateways

Recurso: Gateway

O gateway representa a configuração de um proxy, normalmente um balanceador de carga. Ele captura o "ip:port" em que os serviços são expostos pelo proxy, além de todas as configurações de política. As rotas se referem aos gateways para determinar como as solicitações precisam ser roteadas por ele. Próximo ID: 33

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

string

Obrigatório. Nome do recurso de gateway. 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.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Opcional. Conjunto de tags de rótulo associadas ao recurso de gateway.

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

string

Opcional. Uma descrição em 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. Se não for especificado, será retornado um erro.
addresses[]

string

Opcional. Nenhum 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

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

integer

Obrigatório. Um ou mais números de porta (1-65535) que vão receber tráfego para o gateway. O proxy é vinculado às portas especificadas. Os gateways do tipo "SECURE_WEB_GATEWAY" estão limitados a uma porta. Os gateways do tipo "OPEN_MESH" escutam 0.0.0.0 para IPv4 e :: para IPv6 e dão suporte a várias portas.
scope

string

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

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

string

Opcional. Uma referência de URL totalmente qualificada de ServerTLSPolicy. 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 na SNI) ao estabelecer uma conexão TLS. Este recurso só se aplica a gateways do tipo "SECURE_WEB_GATEWAY".
gatewaySecurityPolicy

string

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

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

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

Atualmente, 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 este SWG está alocado. Por exemplo: projects/*/regions/us-central1/subnetworks/network-1

Atualmente, 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.
envoyHeaders

enum (EnvoyHeaders)

Opcional. Determina se o envoy inserirá cabeçalhos de depuração internos em solicitações upstream. Outros cabeçalhos 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

Tipos enumerados
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 TrafficDirector.
SECURE_WEB_GATEWAY O tipo de gateway gerenciado pelo cliente é SecureWebGateway (SWG).

IpVersion

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

Tipos enumerados
IP_VERSION_UNSPECIFIED O tipo quando a versão do IP não é especificada. O padrão é IPV4.
IPV4 O tipo de IP versão 4.
IPV6 O tipo do IP versão 6.

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