REST Resource: projects.locations.grpcRoutes

资源：GrpcRoute

GrpcRoute 用于定义如何路由由网格或网关资源路由的 gRPC 流量。

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

string

必需。GrpcRoute 资源的名称。它与模式 projects/*/locations/global/grpcRoutes/<grpc_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"。
labels

map (key: string, value: string)

可选。与 GrpcRoute 资源关联的标签标记集。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
description

string

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

string

必需。具有可选端口的服务主机名，此端口用于描述流量。

格式：[:]

主机名是网络主机的完全限定域名。这与主机名的 RFC 1123 定义一致，但有两个值得注意的例外情况：- 不允许使用 IP。- 主机名可以带有通配符标签 (*.) 前缀。通配符标签必须单独出现，作为第一个标签。

主机名可以是“精确的”，即不含网络主机的终止点的域名（例如 foo.example.com），也可以是“通配符”（这是以单个通配符标签为前缀的域名（例如 *.example.com）。

请注意，根据 RFC1035 和 RFC1123，标签必须由小写字母数字字符或“-”组成，且必须以字母数字字符开头和结尾。不允许使用其他标点符号。

与网格或网关关联的路由必须具有唯一的主机名。如果您尝试附加多个具有冲突主机名的路由，该配置将会被拒绝。

例如，虽然主机名 *.foo.bar.com 和 *.bar.com 的路由可以与同一路由相关联，但无法将两个路由都与 *.bar.com 关联或同时与 bar.com 关联。

如果指定了端口，则 gRPC 客户端必须使用带有端口的通道 URI（即“xds:///service:123”）来匹配此规则（即“xds:///service:123”），否则必须提供不带端口的 URI（即“xds:///service”）。
meshes[]

string

可选。网格定义了此 GrpcRoute 连接到的网格列表，作为路由规则之一，用于路由网格处理的请求。

每个网格引用都应符合以下模式：projects/*/locations/global/meshes/<mesh_name>
gateways[]

string

可选。网关定义了此 GrpcRoute 连接到的网关列表，作为路由规则之一，用于路由网关处理的请求。

每个网关引用都应符合以下格式：projects/*/locations/global/gateways/<gateway_name>
rules[]

object (RouteRule)

必需。用于定义如何路由流量的详细规则列表。

在单个 GrpcRoute 中，将执行与第一个匹配的 GrpcRoute.RouteRule 关联的 GrpcRoute.RouteAction。必须提供至少一条规则。

RouteRule

说明如何路由流量。

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

object (RouteMatch)

可选。匹配定义用于将规则与传入的 gRPC 请求匹配的条件。每个匹配都是独立的，即只要满足任一匹配项，就会匹配此规则。如果未指定匹配字段，此规则将无条件匹配流量。
action

object (RouteAction)

必需。用于定义如何路由流量的详细规则。此字段为必填字段。

RouteMatch

匹配流量的条件。如果提供的所有字段都匹配，则 RouteMatch 被视为匹配。

JSON 表示法 
{
  "headers": [
    {
      object (HeaderMatch)
    }
  ],
  "method": {
    object (MethodMatch)
  }
}
字段
headers[]

object (HeaderMatch)

可选。指定要匹配的标头集合。
method

object (MethodMatch)

可选。要匹配的 gRPC 方法。如果此字段为空或省略，将匹配所有方法。

MethodMatch

指定针对方法的匹配。

JSON 表示法 
{
  "type": enum (Type),
  "grpcService": string,
  "grpcMethod": string,
  "caseSensitive": boolean
}
字段
type

enum (Type)

可选。指定如何匹配名称。如果未指定，则系统会使用默认值“EXACT”。
grpcService

string

必需。要匹配的服务的名称。如果未指定，将匹配所有服务。
grpcMethod

string

必需。要匹配的方法的名称。如果未指定，将匹配所有方法。
caseSensitive

boolean

可选。指定匹配项区分大小写。默认值为 true。caseSensitive 不得与 REGULAR_EXPRESSION 类型一起使用。

类型

匹配的类型。

枚举
TYPE_UNSPECIFIED 未指定。
EXACT 将仅与提供的名称完全匹配。
REGULAR_EXPRESSION 会将 grpcMethod 和 grpcService 解释为正则表达式。支持 RE2 语法。

HeaderMatch

与标头集合的匹配。

JSON 表示法 
{
  "type": enum (Type),
  "key": string,
  "value": string
}
字段
type

enum (Type)

可选。指定如何匹配标头的值。如果未指定，则系统会使用默认值 EXACT。
key

string

必需。标头的键。
value

string

必需。标头的值。

类型

匹配类型。

枚举
TYPE_UNSPECIFIED 未指定。
EXACT 将仅与提供的值完全匹配。
REGULAR_EXPRESSION 将匹配与值指定的前缀相符的路径。支持 RE2 语法。

RouteAction

指定如何路由匹配的流量。

JSON 表示法 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "faultInjectionPolicy": {
    object (FaultInjectionPolicy)
  },
  "timeout": string,
  "retryPolicy": {
    object (RetryPolicy)
  },
  "statefulSessionAffinity": {
    object (StatefulSessionAffinityPolicy)
  },
  "idleTimeout": string
}
字段
destinations[]

object (Destination)

可选。流量应转发到的目标服务。如果指定了多个目标位置，则系统会根据这些目标位置的权重字段在后端服务之间拆分流量。
faultInjectionPolicy

object (FaultInjectionPolicy)

可选。为流量引入的故障注入规范，旨在测试客户端对目标服务故障的弹性。在故障注入过程中，当客户端向目的地发送请求时，系统可能会在将这些请求发送到目标服务之前，先向一定比例的请求引入延迟。同样，来自客户端的请求也可以被取消一定比例的请求。

配置了 faultInjectionPolicy 的客户端将忽略超时和 reCAPTCHAPolicy
timeout

string (Duration format)

可选。指定所选路由的超时时间。超时是根据请求完成处理（即数据流结束）直到响应完成处理的时间计算得出的。超时包括所有重试。

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

object (RetryPolicy)

可选。指定与此路由关联的重试政策。
statefulSessionAffinity

object (StatefulSessionAffinityPolicy)

可选。指定基于 Cookie 的有状态会话亲和性。
idleTimeout

string (Duration format)

可选。指定所选路由的空闲超时。空闲超时是指在上行或下行连接上未发送或接收字节的时间段。如果未设置，则默认空闲超时时间为 1 小时。如果设置为 0s，超时将被停用。

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

目的地

流量将路由到的目的地。

JSON 表示法 
{

  // Union field destination_type can be only one of the following:
  "serviceName": string
  // End of list of possible types for union field destination_type.
  "weight": integer
}
字段
联合字段 destination_type。指定将流量路由到的目标类型。destination_type 只能是下列其中一项：
serviceName

string

必需。将流量路由到的目标服务的网址。必须引用 BackendService 或 ServiceDirectoryService。
weight

integer

可选。指定转发到 serviceName 字段引用的后端的请求比例。计算公式如下：- 权重/总和（此目标列表中的权重）。对于非零值，可能与此处定义的精确比例存在一些 epsilon，具体取决于实现支持的精度。

如果仅指定一个 serviceName 且其权重大于 0，则全部流量都会转发到该后端。

如果为任何一个服务名称指定了权重，则需要为所有服务名称指定权重。

如果未指定所有服务的权重，则流量将按照所有服务的比例进行分配。

FaultInjectionPolicy

为流量引入的故障注入规范，旨在测试客户端对目标服务故障的弹性。在故障注入过程中，当客户端向目的地发送请求时，系统可能会在将这些请求发送到目标服务之前，先向一定比例的请求引入延迟。同样，来自客户端的请求也可以被取消一定比例的请求。

JSON 表示法 
{
  "delay": {
    object (Delay)
  },
  "abort": {
    object (Abort)
  }
}
字段
delay

object (Delay)

向客户端请求注入延迟的规范。
abort

object (Abort)

关于中止客户端请求的规范。

延迟

关于在将客户端请求发送到目的地之前，作为故障注入一部分如何延迟的规范。

JSON 表示法 
{
  "fixedDelay": string,
  "percentage": integer
}
字段
fixedDelay

string (Duration format)

在转发请求前指定固定的延迟时间。

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

integer

将注入延迟的流量百分比。

该值必须介于 [0, 100] 之间

取消

关于故障注入功能在将客户端请求发送到目的地之前如何中止的规范。

JSON 表示法 
{
  "httpStatus": integer,
  "percentage": integer
}
字段
httpStatus

integer

用于中止请求的 HTTP 状态代码。

该值必须介于 200 和 599 之间（含 200 和 599）。
percentage

integer

将被取消的流量百分比。

该值必须介于 [0, 100] 之间

RetryPolicy

重试规范。

JSON 表示法 
{
  "retryConditions": [
    string
  ],
  "numRetries": integer
}
字段
retryConditions[]

string

  • connect-failure：路由器将在未能连接到后端服务时重试，例如由于连接超时。
  • refused-stream：如果后端服务重置信息流并返回 REFUSED_STREAM 错误代码，则路由器将重试。这种重置类型表示可以放心重试。
  • 已取消：如果响应标头中的 gRPC 状态代码设置为已取消，则路由器将重试
  • 截止期限已过：如果响应标头中的 gRPC 状态代码设置为截止期限，路由器将重试
  • 资源耗尽：如果响应标头中的 gRPC 状态代码设置为资源耗尽，路由器将重试
  • 不可用：如果响应标头中的 gRPC 状态代码设置为不可用，则路由器将重试
numRetries

integer (uint32 format)

指定允许的重试次数。此数字必须大于 0。如果未指定，则默认为 1。

StatefulSessionAffinityPolicy

基于 Cookie 的有状态会话亲和性规范，其中日期平面提供名称为“GSSA”的“会话 Cookie”，对特定目标主机进行编码，只要目标主机保持正常运行且正常运行，每个包含该 Cookie 的请求就会定向到该主机。

gRPC 无代理网格库或边车代理将管理会话 Cookie，但客户端应用代码负责将 Cookie 从会话中的每个 RPC 复制到下一个 RPC。

JSON 表示法 
{
  "cookieTtl": string
}
字段
cookieTtl

string (Duration format)

必需。数据平面生成的 Set-Cookie 标头的 Cookie TTL 值。Cookie 的生命周期可设置为 1 到 86400 秒（含 24 小时）之间的值。

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

方法

create

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

delete

 删除单个 GrpcRoute。

get

 获取单个 GrpcRoute 的详细信息。

list

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

patch

 更新单个 GrpcRoute 的参数。