REST Resource: projects.locations.tlsRoutes

資源：TlsRoute

TlsRoute 會根據 SNI 和其他相符的 L3 屬性，定義流量應如何轉送。

JSON 表示法 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "rules": [
    {
      object (RouteRule)
    }
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "labels": {
    string: string,
    ...
  }
}
欄位
name

string

這是必要旗標，TlsRoute 資源的名稱。符合模式 projects/*/locations/global/tlsRoutes/tls_route_name>。
createTime

string (Timestamp format)

僅供輸出。資源建立時間的時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。資源更新時間的時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
description

string

(非必要) 資源的自由文字說明。長度上限為 1024 個半形字元。
rules[]

object (RouteRule)

這是必要旗標，定義流量轉送和處理方式的規則。您必須提供至少一個 RouteRule。如果有多項規則，系統會採取相符的第一個規則所指定的動作。
meshes[]

string

(非必要) 網格定義了這個 TlsRoute 附加的網格清單，做為轉送規則之一，用於轉送網格提供的要求。

每個網格參照都應符合以下格式：projects/*/locations/global/meshes/<mesh_name>

附加的網格應為 SIDECAR 類型
gateways[]

string

(非必要) 閘道定義了這個 TlsRoute 所連結的閘道清單，做為其中一個轉送規則，用於轉送由閘道提供的請求。

每個閘道參照都應符合以下格式：projects/*/locations/global/gateways/<gateway_name>
labels

map (key: string, value: string)

(非必要) 與 TlsRoute 資源相關聯的標籤標記集。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

RouteRule

指定如何比對流量，以及比對流量後的轉送方式。

JSON 表示法 
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
欄位
matches[]

object (RouteMatch)

這是必要旗標，RouteMatch 會定義用於將要求與特定動作比對的述詞。多個比對類型會以「或」邏輯進行評估。
action

object (RouteAction)

這是必要旗標，定義如何轉送相符流量的詳細規則。

RouteMatch

RouteMatch 會定義用於將要求與特定動作比對的述詞。多個比對類型會以「AND」方式進行評估。如未指定 routeMatch 欄位，這個規則會無條件比對流量。

JSON 表示法 
{
  "sniHost": [
    string
  ],
  "alpn": [
    string
  ]
}
欄位
sniHost[]

string

(非必要) 要比對的 SNI (伺服器名稱指標)。SNI 會與所有萬用字元網域進行比對，也就是說，www.example.com 會先與 www.example.com 比對，然後是 *.example.com，再來是 *.com.。系統不支援部分萬用字元，因此 *w.example.com 這類值無效。至少須提供 sniHost 或 alpn 其中一個。最多可為所有比對項目設定 100 個 SNI 主機。
alpn[]

string

(非必要) 要比對的 ALPN (應用程式層協定協商)。例如：「http/1.1」、「h2」。至少須提供 sniHost 或 alpn 其中一個。最多可為所有比對項目設定 5 個 alpn。

RouteAction

轉送流量和套用相關政策的規格。

JSON 表示法 
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "idleTimeout": string
}
欄位
destinations[]

object (RouteDestination)

這是必要旗標，應轉送流量的目的地服務。至少須提供一個目的地服務。
idleTimeout

string (Duration format)

(非必要) 指定所選路徑的閒置逾時時間。閒置逾時時間的定義為上游或下游連線在一段時間內未傳送或接收任何位元組的時間。如果未設定，預設閒置逾時時間為 1 小時。如果設為 0 秒，系統就會停用逾時設定。

以秒為單位的時間長度，最多可有 9 個小數位數，結尾為「s」，例如："3.5s"。

RouteDestination

說明要將流量導向的目的地。

JSON 表示法 
{
  "serviceName": string,
  "weight": integer
}
欄位
serviceName

string

這是必要旗標，要將流量轉送至的 BackendService 網址。
weight

integer

(非必要) 指定要求轉送至 serviceName 欄位所參照的後端的比例。計算方式如下：- 權重/Sum(目的地中的權重)。所有目的地的權重總和不必為 100。

方法

create

 在指定專案和位置中建立新的 TlsRoute。

delete

 刪除單一 TlsRoute。

get

 取得單一 TlsRoute 的詳細資料。

list

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

patch

 更新單一 TlsRoute 的參數。