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

ID。TlsRoute 資源的名稱。符合模式 projects/*/locations/global/tlsRoutes/tls_route_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"

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 會定義用於將要求與指定動作比對的述詞。系統會對多個比對類型執行「OR」運算,以進行評估。至少須提供一個 RouteMatch。

action

object (RouteAction)

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

RouteMatch

RouteMatch 會定義用於將要求與指定動作比對的述詞。系統會「AND」多個比對類型,然後進行評估。

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 個 ALP。

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 欄位所參照後端的請求比例。計算方式如下:- 權重/目的地權重總和。所有目的地的權重總和不一定要達到 100。

方法

create

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

delete

刪除單一 TlsRoute。

get

取得單一 TlsRoute 的詳細資料。

list

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

patch

更新單一 TlsRoute 的參數。

setIamPolicy

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

testIamPermissions

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