REST Resource: projects.locations.gateways

资源：网关

网关表示代理的配置，通常是负载均衡器。它会捕获代理公开服务的 ip:port 以及任何政策配置。路由会引用网关，以指定此网关应如何路由请求。

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)
}
字段
name

string

标识符。网关资源的名称。它符合格式 projects/*/locations/*/gateways/<gateway_name>。
createTime

string (Timestamp format)

仅限输出。创建资源时的时间戳。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。更新资源时的时间戳。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
labels

map (key: string, value: string)

可选。与 Gateway 资源关联的一组标签标记。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
description

string

可选。资源的自由文本说明。长度上限为 1024 个字符。
type

enum (Type)

不可变。由客户管理的网关类型。此字段为必填字段。如果未指定，则会返回错误。
addresses[]

string

可选。网关将通过其接收流量的零个或一个 IPv4 或 IPv6 地址。如果未提供地址，系统会分配子网中的 IP

此字段仅适用于类型为“SECURE_WEB_GATEWAY”的网关。类型为“OPEN_MESH”的网关监听 0.0.0.0（对于 IPv4）和 ::（对于 IPv6）。
ports[]

integer

必需。一个或多个端口号 (1-65535)，网关将通过这些端口接收流量。代理会绑定到指定的端口。类型为“SECURE_WEB_GATEWAY”的网关仅限 1 个端口。类型为 'OPEN_MESH' 的网关监听 IPv4 的 0.0.0.0 和 IPv6 的 ::，并支持多个端口。
scope

string

可选。范围决定了如何合并多个网关实例的配置。具有相同范围的多个网关实例的配置将合并为单个配置，并以此形式提供给代理/负载均衡器。

长度上限为 64 个字符。范围应以字母开头，且只能包含字母、数字、连字符。
serverTlsPolicy

string

可选。完全限定的 ServerTLSPolicy 网址引用。指定如何终结 TLS 流量。如果为空，则表示停用 TLS 终结。
certificateUrls[]

string

可选。完全限定的证书网址引用。代理在建立 TLS 连接时会提供证书（根据 SNI 选择）。此功能仅适用于类型为“SECURE_WEB_GATEWAY”的网关。
gatewaySecurityPolicy

string

可选。完全限定的 GatewaySecurityPolicy 网址引用。定义服务器应如何将安全政策应用于入站（虚拟机到代理）发起的连接。

例如：projects/*/locations/*/gatewaySecurityPolicies/swg-policy。

此政策特定于类型为“SECURE_WEB_GATEWAY”的网关。
network

string

可选。用于标识使用此配置的 VPC 网络的相对资源名称。例如：projects/*/global/networks/network-1。

目前，此字段仅特定于类型为“SECURE_WEB_GATEWAY”的网关。
subnetwork

string

可选。用于标识分配了此 SWG 的子网的相对资源名称。例如：projects/*/regions/us-central1/subnetworks/network-1

目前，此字段仅特定于类型为“SECURE_WEB_GATEWAY”的网关。
ipVersion

enum (IpVersion)

可选。此网关将使用的 IP 版本。有效选项为 IPV4 或 IPV6。默认值为 IPV4。
routingMode

enum (RoutingMode)

可选。网关的路由模式。此字段仅可针对 SECURE_WEB_GATEWAY 类型的网关进行配置。对于类型为 SECURE_WEB_GATEWAY 的网关，此字段是必填字段。
envoyHeaders

enum (EnvoyHeaders)

可选。确定 Envoy 是否会将内部调试标头插入到上行请求中。其他 Envoy 标头可能仍会被注入。默认情况下，Envoy 不会插入任何调试标头。

类型

由客户管理的网关类型。可能的值包括：* OPEN_MESH * SECURE_WEB_GATEWAY

枚举
TYPE_UNSPECIFIED 未指定由客户管理的网关类型。
OPEN_MESH 由客户管理的网关类型为 TrafficDirector Open Mesh。
SECURE_WEB_GATEWAY 由客户管理的网关类型为 SecureWebGateway (SWG)。

IpVersion

网关的 IP 版本类型。可能的值包括：* IPV4 * IPV6

枚举
IP_VERSION_UNSPECIFIED 未指定 IP 版本时的类型。默认为 IPV4。
IPV4 IP 版本 4 的类型。
IPV6 IP 版本 6 的类型。

RoutingMode

网关的路由模式，用于确定网关如何路由流量。目前，此字段仅适用于 SECURE_WEB_GATEWAY 类型的网关。可能的值包括：* EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

枚举
EXPLICIT_ROUTING_MODE 路由模式是显式的；客户端已配置为通过网关发送流量。这是默认的路由模式。
NEXT_HOP_ROUTING_MODE 路由模式为下一个跃点。客户端无法感知网关，且可以配置路由（高级路由或其他路由类型）以将流量从客户端定向到网关。然后，网关充当目标位置的下一个跃点。

方法

create

 在给定的项目和位置中创建新 Gateway。

delete

 删除单个 Gateway。

get

 获取单个网关的详细信息。

getIamPolicy

 获取资源的访问权限控制政策。

list

 列出给定项目和位置中的 Gateway。

patch

 更新单个 Gateway 的参数。

setIamPolicy

 针对指定资源设置访问权限控制政策。

testIamPermissions

 返回调用者对指定资源拥有的权限。