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

省略可。フリーテキストでのリソースの説明。最大長は 1,024 文字です。
rules[]

object (RouteRule)

必須。トラフィックのルーティング方法と処理方法を定義するルール。少なくとも 1 つの RouteRule を選択する必要があります。ルールが複数ある場合、実行されるアクションは、最初に一致したルールになります。
meshes[]

string

省略可。メッシュは、この TcpRoute が接続されるメッシュのリストを、メッシュによって処理されるリクエストをルーティングするルーティング ルールの一つとして定義します。

各メッシュの参照は 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」で結合されます。少なくとも 1 つの 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（Application-Layer Protocol Negotiation）。例: 「http/1.1」、「h2」。少なくとも sniHost と alpn のどちらか一つは必要です。すべての一致で最大 5 つの alpns を設定できます。

RouteAction

トラフィックのルーティングと関連ポリシーの適用のための仕様。

JSON 表現 
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "idleTimeout": string
}
フィールド
destinations[]

object (RouteDestination)

必須。トラフィックの転送先となる宛先サービス。少なくとも 1 つの宛先サービスが必要です。
idleTimeout

string (Duration format)

省略可。選択したルートのアイドル タイムアウトを指定します。アイドル タイムアウトは、アップストリーム接続とダウンストリーム接続のいずれにおいても送受信されるバイトがない期間として定義されます。設定しない場合、デフォルトのアイドル タイムアウトは 1 時間です。0 秒に設定すると、タイムアウトは無効になります。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

RouteDestination

トラフィックのルーティング先を記述します。

JSON 表現 
{
  "serviceName": string,
  "weight": integer
}
フィールド
serviceName

string

必須。トラフィックのルーティング先となる BackendService の URL。
weight

integer

省略可。serviceName フィールドによって参照されるバックエンドに転送されるリクエストの割合を指定します。これは、すべての宛先の weight/Sum（宛先の重み）重みの合計が 100 になる必要はありません。

メソッド

create

 指定されたプロジェクトとロケーションで新しい TlsRoute を作成します。

delete

 1 つの TlsRoute を削除します。

get

 1 つの TlsRoute の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションの TlsRoute を一覧表示します。

patch

 1 つの TlsRoute のパラメータを更新します。

setIamPolicy

 指定したリソースにアクセス制御ポリシーを設定します。

testIamPermissions

 指定されたリソースに対して呼び出し元が持っている権限を返します。