Resource: TlsRoute
TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes.
JSON representation |
---|
{
"name": string,
"selfLink": string,
"createTime": string,
"updateTime": string,
"description": string,
"rules": [
{
object ( |
Fields | |
---|---|
name |
Required. Name of the TlsRoute resource. It matches pattern |
selfLink |
Output only. Server-defined URL of this resource |
createTime |
Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
rules[] |
Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. |
meshes[] |
Optional. Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: The attached Mesh should be of a type SIDECAR |
gateways[] |
Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: |
RouteRule
Specifies how to match traffic and how to route traffic when traffic is matched.
JSON representation |
---|
{ "matches": [ { object ( |
Fields | |
---|---|
matches[] |
Required. RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. |
action |
Required. The detailed rule defining how to route matched traffic. |
RouteMatch
RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic.
JSON representation |
---|
{ "sniHost": [ string ], "alpn": [ string ] } |
Fields | |
---|---|
sniHost[] |
Optional. SNI (server name indicator) to match against. SNI will be matched against all wildcard domains, i.e. www.example.com will be first matched against www.example.com, then *.example.com, then *.com. Partial wildcards are not supported, and values like *w.example.com are invalid. At least one of sniHost and alpn is required. Up to 5 sni hosts across all matches can be set. |
alpn[] |
Optional. ALPN (Application-Layer Protocol Negotiation) to match against. Examples: "http/1.1", "h2". At least one of sniHost and alpn is required. Up to 5 alpns across all matches can be set. |
RouteAction
The specifications for routing traffic and applying associated policies.
JSON representation |
---|
{
"destinations": [
{
object ( |
Fields | |
---|---|
destinations[] |
Required. The destination services to which traffic should be forwarded. At least one destination service is required. |
RouteDestination
Describe the destination for traffic to be routed to.
JSON representation |
---|
{ "serviceName": string, "weight": integer } |
Fields | |
---|---|
serviceName |
Required. The URL of a BackendService to route traffic to. |
weight |
Optional. Specifies the proportion of requests forwareded to the backend referenced by the serviceName field. This is computed as: weight/Sum(weights in destinations) Weights in all destinations does not need to sum up to 100. |
Methods |
|
---|---|
|
Creates a new TlsRoute in a given project and location. |
|
Deletes a single TlsRoute. |
|
Gets details of a single TlsRoute. |
|
Lists TlsRoute in a given project and location. |
|
Updates the parameters of a single TlsRoute. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |