REST Resource: projects.locations.grpcRoutes

string

必需。GrpcRoute 资源的名称。它与 projects/*/locations/global/grpcRoutes/<grpc_route_name> 格式匹配

string

仅限输出。此资源的服务器定义网址

string (Timestamp format)

仅限输出。创建资源时的时间戳。

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

string (Timestamp format)

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

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

map (key: string, value: string)

可选。与 GrpcRoute 资源关联的一组标签。

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

string

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

string

必需。服务主机名，以及此路由描述流量的可选端口。

格式：[:]

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

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

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

与网状网络或网关关联的路由必须具有唯一的主机名。如果您尝试附加具有冲突主机名的多个路线，系统会拒绝相应配置。

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

如果指定了端口，则 gRPC 客户端必须使用包含端口的通道 URI 才能与此规则匹配（即“xds:///service:123”），否则必须提供不含端口的 URI（即“xds:///service”）。

string

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

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

string

可选。Gateways 定义了此 GrpcRoute 附加到的网关列表，作为路由网关所处理请求的路由规则之一。

每个网关引用都应与以下模式匹配：projects/*/locations/global/gateways/<gateway_name>

object (RouteRule)

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

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

object (RouteMatch)

可选。匹配项定义了用于将规则与传入 gRPC 请求进行匹配的条件。每个匹配项都是独立的，也就是说，只要满足其中任一匹配项，系统就会匹配此规则。如果未指定任何 matches 字段，此规则将无条件匹配流量。

object (RouteAction)

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

object (HeaderMatch)

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

object (MethodMatch)

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

enum (Type)

可选。指定如何与名称进行匹配。如果未指定，则使用默认值“EXACT”。

string

必需。要匹配的服务的名称。如果未指定该项，则与所有服务进行匹配。

string

必需。要匹配的方法的名称。如果未指定该项，则与所有方法进行匹配。

boolean

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

enum (Type)

可选。指定如何与标头的值进行匹配。如果未指定，则使用默认值 EXACT。

string

必需。标头的键。

string

必需。标头的值。

object (Destination)

可选。应将流量转发到的目标服务。如果指定多个目的地，系统会根据这些目的地的 weight 字段在后端服务之间拆分流量。

object (FaultInjectionPolicy)

可选。用于向流量中注入故障的规范，以测试客户端对目标服务故障的弹性。在故障注入过程中，当客户端向目的地发送请求时，系统可能会对一定比例的请求引入延迟，然后再将这些请求发送到目的地服务。同样，系统也可以根据请求百分比来终止来自客户端的请求。

使用 faultInjectionPolicy 配置的客户端会忽略 timeout 和 retryPolicy

string (Duration format)

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

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

object (RetryPolicy)

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

object (StatefulSessionAffinityPolicy)

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

string (Duration format)

可选。指定选定路由的空闲超时时间。闲置超时是指上游或下游连接上没有发送或接收任何字节的时间段。如果未设置，默认空闲超时时间为 1 小时。如果设置为 0 秒，则会停用超时。

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

string

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

integer

可选。指定转发到 serviceName 字段所引用的后端的请求比例。计算公式如下：- weight/Sum(weights in this destination list)。对于非零值，此处定义的确切比例可能会与实际比例存在一些 epsilon，具体取决于实现支持的精度。

如果只指定了 1 个 serviceName，并且其权重大于 0，则系统会将 100% 的流量转发到该后端。

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

如果未为所有服务指定权重，则流量会按相等的比例分配给所有服务。

object (Delay)

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

object (Abort)

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

string (Duration format)

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

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

integer

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

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

integer

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

该值必须介于 200 到 599 之间（包括这两个数值）。

integer

将被中止的流量的百分比。

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

string

• connect-failure：路由器在连接到后端服务失败时（例如由于连接超时）会重试。
• refused-stream：如果后端服务使用 REFUSED_STREAM 错误代码重置了数据流，路由器将重试。此重置类型表示可以放心地重试。
• cancelled：如果响应标头中的 gRPC 状态代码设置为 cancelled，路由器将重试
• deadline-exceeded：如果响应标头中的 gRPC 状态代码设置为 deadline-exceeded，路由器将重试
• resource-exhausted：如果响应标头中的 gRPC 状态代码设置为 resource-exhausted，路由器将重试
• 不可用：如果响应标头中的 gRPC 状态代码设置为不可用，路由器将重试

integer (uint32 format)

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

string (Duration format)

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

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