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 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。更新资源时的时间戳。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

description

string

可选。资源的自由文本说明。长度上限为 1024 个字符。

rules[]

object (RouteRule)

必需。用于定义流量路由和处理方式的规则。必须提供至少一个 RouteRule。如果存在多条规则,系统将执行与第一条规则匹配的操作。

meshes[]

string

可选。Meshes 定义了此 TlsRoute 附加到的网格的列表,作为路由规则之一来路由网格提供的请求。

每个网格引用都应与以下模式匹配:projects/*/locations/global/meshes/<mesh_name>

附加的网格应为 SIDECAR 类型

gateways[]

string

可选。Gateways 定义了此 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 秒,则会停用超时。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

RouteDestination

描述要将流量路由到的目的地。

JSON 表示法
{
  "serviceName": string,
  "weight": integer
}
字段
serviceName

string

必需。要将流量路由到的 BackendService 的网址。

weight

integer

可选。指定转发到 serviceName 字段所引用的后端的请求比例。计算方式为:- weight/Sum(weights in destinations) 所有目标平台的权重总和不必等于 100。

方法

create

在给定的项目和位置中创建新的 TlsRoute。

delete

删除单个 TlsRoute。

get

获取单个 TlsRoute 的详细信息。

list

列出给定项目和位置中的 TlsRoute。

patch

更新单个 TlsRoute 的参数。

setIamPolicy

针对指定资源设置访问权限控制政策。

testIamPermissions

返回调用者对指定资源拥有的权限。