REST Resource: projects.locations.gateways

資源：閘道

閘道代表 Proxy 的設定，通常是負載平衡器。這項設定會擷取 Proxy 公開服務的 IP:通訊埠，以及任何政策設定。路由會參照閘道，指定閘道應如何轉送要求。

JSON 表示法 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "type": enum (Type),
  "addresses": [
    string
  ],
  "ports": [
    integer
  ],
  "allPorts": boolean,
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "allowGlobalAccess": boolean,
  "envoyHeaders": enum (EnvoyHeaders)
}
欄位
name

string

ID。閘道資源名稱。符合 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)

選用。與閘道資源相關聯的一組標籤。

包含 "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)，閘道會透過這些通訊埠接收流量。Proxy 會繫結至指定通訊埠。「SECURE_WEB_GATEWAY」類型的閘道最多只能有 5 個通訊埠。「OPEN_MESH」類型的閘道會監聽 IPv4 的 0.0.0.0 和 IPv6 的 ::，並支援多個通訊埠。
allPorts

boolean

選用。如果設為 true，閘道會監聽所有通訊埠。這與 ports 欄位互斥。這個欄位僅適用於「SECURE_WEB_GATEWAY」類型的閘道。
scope

string

選用。範圍會決定如何合併多個閘道執行個體的設定。如果多個閘道執行個體具有相同範圍，系統會合併這些執行個體的設定，並以單一設定的形式呈現給 Proxy/負載平衡器。

長度上限為 64 個半形字元。範圍只能使用英文字母、數字和連字號，開頭須為英文字母。
serverTlsPolicy

string

選用。完整 ServerTLSPolicy 網址參照。指定 TLS 流量的終止方式。如果留空，則會停用 TLS 終止。
certificateUrls[]

string

選用。完整憑證網址參照。建立 TLS 連線時，Proxy 會出示憑證 (根據 SNI 選取)。這項功能僅適用於「SECURE_WEB_GATEWAY」類型的閘道。
gatewaySecurityPolicy

string

選用。完整 GatewaySecurityPolicy 網址參照。定義伺服器應如何將安全性政策套用至傳入 (VM 到 Proxy) 的連線。

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

這項政策僅適用於「SECURE_WEB_GATEWAY」類型的閘道。
network

string

選用。相對資源名稱，用於識別使用這項設定的虛擬私有雲網路。例如：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，則必須填寫這個欄位。
allowGlobalAccess

boolean

選用。如果設為 true，閘道會允許來自閘道所在區域以外用戶端的流量。這個欄位只能用於 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

 在指定專案和位置建立新的閘道。

delete

 刪除單一閘道。

get

 取得單一閘道的詳細資料。

list

 列出指定專案和位置中的閘道。

patch

 更新單一閘道的參數。

setIamPolicy

 設定指定資源的存取控管政策。

testIamPermissions

 傳回呼叫端對指定資源所擁有的權限。