REST Resource: projects.locations.gateways

资源：网关

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

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

string

必需。网关资源的名称。它与 projects/*/locations/*/gateways/<gateway_name> 格式匹配。
createTime

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

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

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

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

包含一系列 "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”的网关在 IPv4 中监听 0.0.0.0，在 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。
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 的类型。

方法

create

 在给定的项目和位置中创建一个新的网关。

delete

 删除单个网关。

get

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

getIamPolicy

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

list

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

patch

 更新单个网关的参数。

setIamPolicy

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

testIamPermissions

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