REST Resource: projects.locations.gateways

資源：Gateway

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

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

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 位址數量，為 0 或 1。如未提供位址，系統會分配子網路中的 IP 位址

這個欄位僅適用於類型為「SECURE_WEB_GATEWAY」的閘道。類型為「OPEN_MESH」的閘道會監聽 IPv4 的 0.0.0.0，以及 IPv6 的 ::。
ports[]

integer

這是必要旗標，一或多個通訊埠號碼 (1-65535)，閘道會透過這些通訊埠接收流量。Proxy 會繫結至指定的通訊埠。類型為「SECURE_WEB_GATEWAY」的閘道上限為 1 個通訊埠。類型為「OPEN_MESH」的閘道會監聽 0.0.0.0 (IPv4) 和 :: (IPv6)，並支援多個連接埠。
scope

string

(非必要) 範圍會決定如何合併多個 Gateway 例項的設定。針對多個閘道執行個體的設定 (具有相同範圍) 會合併為單一設定，並呈現給 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 的閘道，這是必要欄位。
envoyHeaders

enum (EnvoyHeaders)

(非必要) 決定是否要將內部偵錯標頭插入上游要求。但其他 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

 刪除單一閘道。

get

 取得單一 Gateway 的詳細資料。

list

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

patch

 更新單一 Gateway 的參數。

setIamPolicy

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

testIamPermissions

 傳回呼叫者在指定資源上擁有的權限。