networking/v1alpha3/virtual_service.pb.html

---
title: Virtual Service
description: Configuration affecting label/content routing, sni routing, etc.
location: https://istio.io/docs/reference/config/networking/virtual-service.html
layout: protoc-gen-docs
generator: protoc-gen-docs
schema: istio.networking.v1alpha3.VirtualService
aliases: [/docs/reference/config/networking/v1alpha3/virtual-service]
number_of_entries: 33
---
<p>Configuration affecting traffic routing. Here are a few terms useful to define
in the context of traffic routing.</p>
<p><code>Service</code> a unit of application behavior bound to a unique name in a
service registry. Services consist of multiple network <em>endpoints</em>
implemented by workload instances running on pods, containers, VMs etc.</p>
<p><code>Service versions (a.k.a. subsets)</code> - In a continuous deployment
scenario, for a given service, there can be distinct subsets of
instances running different variants of the application binary. These
variants are not necessarily different API versions. They could be
iterative changes to the same service, deployed in different
environments (prod, staging, dev, etc.). Common scenarios where this
occurs include A/B testing, canary rollouts, etc. The choice of a
particular version can be decided based on various criterion (headers,
url, etc.) and/or by weights assigned to each version. Each service has
a default version consisting of all its instances.</p>
<p><code>Source</code> - A downstream client calling a service.</p>
<p><code>Host</code> - The address used by a client when attempting to connect to a
service.</p>
<p><code>Access model</code> - Applications address only the destination service
(Host) without knowledge of individual service versions (subsets). The
actual choice of the version is determined by the proxy/sidecar, enabling the
application code to decouple itself from the evolution of dependent
services.</p>
<p>A <code>VirtualService</code> defines a set of traffic routing rules to apply when a host is
addressed. Each routing rule defines matching criteria for traffic of a specific
protocol. If the traffic is matched, then it is sent to a named destination service
(or subset/version of it) defined in the registry.</p>
<p>The source of traffic can also be matched in a routing rule. This allows routing
to be customized for specific client contexts.</p>
<p>The following example on Kubernetes, routes all HTTP traffic by default to
pods of the reviews service with label &ldquo;version: v1&rdquo;. In addition,
HTTP requests with path starting with /wpcatalog/ or /consumercatalog/ will
be rewritten to /newcatalog and sent to pods with label &ldquo;version: v2&rdquo;.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route
spec:
  hosts:
  - reviews.prod.svc.cluster.local
  http:
  - name: &quot;reviews-v2-routes&quot;
    match:
    - uri:
        prefix: &quot;/wpcatalog&quot;
    - uri:
        prefix: &quot;/consumercatalog&quot;
    rewrite:
      uri: &quot;/newcatalog&quot;
    route:
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v2
  - name: &quot;reviews-v1-route&quot;
    route:
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v1
</code></pre>
<p>A subset/version of a route destination is identified with a reference
to a named service subset which must be declared in a corresponding
<code>DestinationRule</code>.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
  name: reviews-destination
spec:
  host: reviews.prod.svc.cluster.local
  subsets:
  - name: v1
    labels:
      version: v1
  - name: v2
    labels:
      version: v2
</code></pre>

<h2 id="VirtualService">VirtualService</h2>
<section>
<p>Configuration affecting traffic routing.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="VirtualService-hosts">
<td><code><a href="#VirtualService-hosts">hosts</a></code></td>
<td><code>string[]</code></td>
<td>
<p>The destination hosts to which traffic is being sent. Could
be a DNS name with wildcard prefix or an IP address.  Depending on the
platform, short-names can also be used instead of a FQDN (i.e. has no
dots in the name). In such a scenario, the FQDN of the host would be
derived based on the underlying platform.</p>
<p>A single VirtualService can be used to describe all the traffic
properties of the corresponding hosts, including those for multiple
HTTP and TCP ports. Alternatively, the traffic properties of a host
can be defined using more than one VirtualService, with certain
caveats. Refer to the
<a href="https://istio.io/docs/ops/best-practices/traffic-management/#split-virtual-services">Operations Guide</a>
for details.</p>
<p><em>Note for Kubernetes users</em>: When short names are used (e.g. &ldquo;reviews&rdquo;
instead of &ldquo;reviews.default.svc.cluster.local&rdquo;), Istio will interpret
the short name based on the namespace of the rule, not the service. A
rule in the &ldquo;default&rdquo; namespace containing a host &ldquo;reviews&rdquo; will be
interpreted as &ldquo;reviews.default.svc.cluster.local&rdquo;, irrespective of
the actual namespace associated with the reviews service. <em>To avoid
potential misconfigurations, it is recommended to always use fully
qualified domain names over short names.</em></p>
<p>The hosts field applies to both HTTP and TCP services. Service inside
the mesh, i.e., those found in the service registry, must always be
referred to using their alphanumeric names. IP addresses are allowed
only for services defined via the Gateway.</p>
<p><em>Note</em>: It must be empty for a delegate VirtualService.</p>

</td>
<td>
No
</td>
</tr>
<tr id="VirtualService-gateways">
<td><code><a href="#VirtualService-gateways">gateways</a></code></td>
<td><code>string[]</code></td>
<td>
<p>The names of gateways and sidecars that should apply these routes.
Gateways in other namespaces may be referred to by
<code>&lt;gateway namespace&gt;/&lt;gateway name&gt;</code>; specifying a gateway with no
namespace qualifier is the same as specifying the VirtualService&rsquo;s
namespace. A single VirtualService is used for sidecars inside the mesh as
well as for one or more gateways. The selection condition imposed by this
field can be overridden using the source field in the match conditions
of protocol-specific routes. The reserved word <code>mesh</code> is used to imply
all the sidecars in the mesh. When this field is omitted, the default
gateway (<code>mesh</code>) will be used, which would apply the rule to all
sidecars in the mesh. If a list of gateway names is provided, the
rules will apply only to the gateways. To apply the rules to both
gateways and sidecars, specify <code>mesh</code> as one of the gateway names.</p>

</td>
<td>
No
</td>
</tr>
<tr id="VirtualService-http">
<td><code><a href="#VirtualService-http">http</a></code></td>
<td><code><a href="#HTTPRoute">HTTPRoute[]</a></code></td>
<td>
<p>An ordered list of route rules for HTTP traffic. HTTP routes will be
applied to platform service ports using HTTP/HTTP2/GRPC protocols, gateway
ports with protocol HTTP/HTTP2/GRPC/TLS-terminated-HTTPS and service
entry ports using HTTP/HTTP2/GRPC protocols.  The first rule matching
an incoming request is used.</p>

</td>
<td>
No
</td>
</tr>
<tr id="VirtualService-tls">
<td><code><a href="#VirtualService-tls">tls</a></code></td>
<td><code><a href="#TLSRoute">TLSRoute[]</a></code></td>
<td>
<p>An ordered list of route rule for non-terminated TLS &amp; HTTPS
traffic. Routing is typically performed using the SNI value presented
by the ClientHello message. TLS routes will be applied to platform
service ports named &lsquo;https-<em>&rsquo;, &rsquo;tls-</em>&rsquo;, unterminated gateway ports using
HTTPS/TLS protocols (i.e. with &ldquo;passthrough&rdquo; TLS mode) and service
entry ports using HTTPS/TLS protocols.  The first rule matching an
incoming request is used.  NOTE: Traffic &lsquo;https-<em>&rsquo; or &rsquo;tls-</em>&rsquo; ports
without associated virtual service will be treated as opaque TCP
traffic.</p>

</td>
<td>
No
</td>
</tr>
<tr id="VirtualService-tcp">
<td><code><a href="#VirtualService-tcp">tcp</a></code></td>
<td><code><a href="#TCPRoute">TCPRoute[]</a></code></td>
<td>
<p>An ordered list of route rules for opaque TCP traffic. TCP routes will
be applied to any port that is not a HTTP or TLS port. The first rule
matching an incoming request is used.</p>

</td>
<td>
No
</td>
</tr>
<tr id="VirtualService-export_to">
<td><code><a href="#VirtualService-export_to">exportTo</a></code></td>
<td><code>string[]</code></td>
<td>
<p>A list of namespaces to which this virtual service is exported. Exporting a
virtual service allows it to be used by sidecars and gateways defined in
other namespaces. This feature provides a mechanism for service owners
and mesh administrators to control the visibility of virtual services
across namespace boundaries.</p>
<p>If no namespaces are specified then the virtual service is exported to all
namespaces by default.</p>
<p>The value &ldquo;.&rdquo; is reserved and defines an export to the same namespace that
the virtual service is declared in. Similarly the value &ldquo;*&rdquo; is reserved and
defines an export to all namespaces.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Destination">Destination</h2>
<section>
<p>Destination indicates the network addressable service to which the
request/connection will be sent after processing a routing rule. The
destination.host should unambiguously refer to a service in the service
registry. Istio&rsquo;s service registry is composed of all the services found
in the platform&rsquo;s service registry (e.g., Kubernetes services, Consul
services), as well as services declared through the
<a href="https://istio.io/docs/reference/config/networking/service-entry/#ServiceEntry">ServiceEntry</a> resource.</p>
<p><em>Note for Kubernetes users</em>: When short names are used (e.g. &ldquo;reviews&rdquo;
instead of &ldquo;reviews.default.svc.cluster.local&rdquo;), Istio will interpret
the short name based on the namespace of the rule, not the service. A
rule in the &ldquo;default&rdquo; namespace containing a host &ldquo;reviews&rdquo; will be
interpreted as &ldquo;reviews.default.svc.cluster.local&rdquo;, irrespective of the
actual namespace associated with the reviews service. <em>To avoid potential
misconfigurations, it is recommended to always use fully qualified
domain names over short names.</em></p>
<p>The following Kubernetes example routes all traffic by default to pods
of the reviews service with label &ldquo;version: v1&rdquo; (i.e., subset v1), and
some to subset v2, in a Kubernetes environment.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route
  namespace: foo
spec:
  hosts:
  - reviews # interpreted as reviews.foo.svc.cluster.local
  http:
  - match:
    - uri:
        prefix: &quot;/wpcatalog&quot;
    - uri:
        prefix: &quot;/consumercatalog&quot;
    rewrite:
      uri: &quot;/newcatalog&quot;
    route:
    - destination:
        host: reviews # interpreted as reviews.foo.svc.cluster.local
        subset: v2
  - route:
    - destination:
        host: reviews # interpreted as reviews.foo.svc.cluster.local
        subset: v1
</code></pre>
<p>And the associated DestinationRule</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
  name: reviews-destination
  namespace: foo
spec:
  host: reviews # interpreted as reviews.foo.svc.cluster.local
  subsets:
  - name: v1
    labels:
      version: v1
  - name: v2
    labels:
      version: v2
</code></pre>
<p>The following VirtualService sets a timeout of 5s for all calls to
productpage.prod.svc.cluster.local service in Kubernetes. Notice that
there are no subsets defined in this rule. Istio will fetch all
instances of productpage.prod.svc.cluster.local service from the service
registry and populate the sidecar&rsquo;s load balancing pool. Also, notice
that this rule is set in the istio-system namespace but uses the fully
qualified domain name of the productpage service,
productpage.prod.svc.cluster.local. Therefore the rule&rsquo;s namespace does
not have an impact in resolving the name of the productpage service.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: my-productpage-rule
  namespace: istio-system
spec:
  hosts:
  - productpage.prod.svc.cluster.local # ignores rule namespace
  http:
  - timeout: 5s
    route:
    - destination:
        host: productpage.prod.svc.cluster.local
</code></pre>
<p>To control routing for traffic bound to services outside the mesh, external
services must first be added to Istio&rsquo;s internal service registry using the
ServiceEntry resource. VirtualServices can then be defined to control traffic
bound to these external services. For example, the following rules define a
Service for wikipedia.org and set a timeout of 5s for HTTP requests.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: ServiceEntry
metadata:
  name: external-svc-wikipedia
spec:
  hosts:
  - wikipedia.org
  location: MESH_EXTERNAL
  ports:
  - number: 80
    name: example-http
    protocol: HTTP
  resolution: DNS
---
apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: my-wiki-rule
spec:
  hosts:
  - wikipedia.org
  http:
  - timeout: 5s
    route:
    - destination:
        host: wikipedia.org
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="Destination-host">
<td><code><a href="#Destination-host">host</a></code></td>
<td><code>string</code></td>
<td>
<p>The name of a service from the service registry. Service
names are looked up from the platform&rsquo;s service registry (e.g.,
Kubernetes services, Consul services, etc.) and from the hosts
declared by <a href="https://istio.io/docs/reference/config/networking/service-entry/#ServiceEntry">ServiceEntry</a>. Traffic forwarded to
destinations that are not found in either of the two, will be dropped.</p>
<p><em>Note for Kubernetes users</em>: When short names are used (e.g. &ldquo;reviews&rdquo;
instead of &ldquo;reviews.default.svc.cluster.local&rdquo;), Istio will interpret
the short name based on the namespace of the rule, not the service. A
rule in the &ldquo;default&rdquo; namespace containing a host &ldquo;reviews&rdquo; will be
interpreted as &ldquo;reviews.default.svc.cluster.local&rdquo;, irrespective of
the actual namespace associated with the reviews service. To avoid
potential misconfiguration, it is recommended to always use fully
qualified domain names over short names.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="Destination-subset">
<td><code><a href="#Destination-subset">subset</a></code></td>
<td><code>string</code></td>
<td>
<p>The name of a subset within the service. Applicable only to services
within the mesh. The subset must be defined in a corresponding
DestinationRule.</p>

</td>
<td>
No
</td>
</tr>
<tr id="Destination-port">
<td><code><a href="#Destination-port">port</a></code></td>
<td><code><a href="#PortSelector">PortSelector</a></code></td>
<td>
<p>Specifies the port on the host that is being addressed. If a service
exposes only a single port it is not required to explicitly select the
port.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRoute">HTTPRoute</h2>
<section>
<p>Describes match conditions and actions for routing HTTP/1.1, HTTP2, and
gRPC traffic. See VirtualService for usage examples.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRoute-name">
<td><code><a href="#HTTPRoute-name">name</a></code></td>
<td><code>string</code></td>
<td>
<p>The name assigned to the route for debugging purposes. The
route&rsquo;s name will be concatenated with the match&rsquo;s name and will
be logged in the access logs for requests matching this
route/match.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-match">
<td><code><a href="#HTTPRoute-match">match</a></code></td>
<td><code><a href="#HTTPMatchRequest">HTTPMatchRequest[]</a></code></td>
<td>
<p>Match conditions to be satisfied for the rule to be
activated. All conditions inside a single match block have AND
semantics, while the list of match blocks have OR semantics. The rule
is matched if any one of the match blocks succeed.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-route">
<td><code><a href="#HTTPRoute-route">route</a></code></td>
<td><code><a href="#HTTPRouteDestination">HTTPRouteDestination[]</a></code></td>
<td>
<p>A HTTP rule can either return a direct_response, redirect or forward (default) traffic.
The forwarding target can be one of several versions of a service (see
glossary in beginning of document). Weights associated with the
service version determine the proportion of traffic it receives.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-redirect">
<td><code><a href="#HTTPRoute-redirect">redirect</a></code></td>
<td><code><a href="#HTTPRedirect">HTTPRedirect</a></code></td>
<td>
<p>A HTTP rule can either return a direct_response, redirect or forward (default) traffic.
If traffic passthrough option is specified in the rule,
route/redirect will be ignored. The redirect primitive can be used to
send a HTTP 301 redirect to a different URI or Authority.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-direct_response">
<td><code><a href="#HTTPRoute-direct_response">directResponse</a></code></td>
<td><code><a href="#HTTPDirectResponse">HTTPDirectResponse</a></code></td>
<td>
<p>A HTTP rule can either return a direct_response, redirect or forward (default) traffic.
Direct Response is used to specify a fixed response that should
be sent to clients.</p>
<p>It can be set only when <code>Route</code> and <code>Redirect</code> are empty.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-delegate">
<td><code><a href="#HTTPRoute-delegate">delegate</a></code></td>
<td><code><a href="#Delegate">Delegate</a></code></td>
<td>
<p>Delegate is used to specify the particular VirtualService which
can be used to define delegate HTTPRoute.</p>
<p>It can be set only when <code>Route</code> and <code>Redirect</code> are empty, and the route
rules of the delegate VirtualService will be merged with that in the
current one.</p>
<p><strong>NOTE</strong>:</p>
<ol>
<li>Only one level delegation is supported.</li>
<li>The delegate&rsquo;s HTTPMatchRequest must be a strict subset of the root&rsquo;s,
otherwise there is a conflict and the HTTPRoute will not take effect.</li>
</ol>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-rewrite">
<td><code><a href="#HTTPRoute-rewrite">rewrite</a></code></td>
<td><code><a href="#HTTPRewrite">HTTPRewrite</a></code></td>
<td>
<p>Rewrite HTTP URIs and Authority headers. Rewrite cannot be used with
Redirect primitive. Rewrite will be performed before forwarding.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-timeout">
<td><code><a href="#HTTPRoute-timeout">timeout</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
<td>
<p>Timeout for HTTP requests, default is disabled.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-retries">
<td><code><a href="#HTTPRoute-retries">retries</a></code></td>
<td><code><a href="#HTTPRetry">HTTPRetry</a></code></td>
<td>
<p>Retry policy for HTTP requests.</p>
<p>Note: the default cluster-wide retry policy, if not specified, is:</p>
<pre><code class="language-yaml">attempts: 2
retryOn: &quot;connect-failure,refused-stream,unavailable,cancelled,503&quot;
</code></pre>
<p>This can be customized in <a href="https://istio.io/latest/docs/reference/config/istio.mesh.v1alpha1/#MeshConfig"><code>Mesh Config</code> <code>defaultHttpRetryPolicy</code></a>.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-fault">
<td><code><a href="#HTTPRoute-fault">fault</a></code></td>
<td><code><a href="#HTTPFaultInjection">HTTPFaultInjection</a></code></td>
<td>
<p>Fault injection policy to apply on HTTP traffic at the client side.
Note that timeouts or retries will not be enabled when faults are
enabled on the client side.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-mirror">
<td><code><a href="#HTTPRoute-mirror">mirror</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>Mirror HTTP traffic to a another destination in addition to forwarding
the requests to the intended destination. Mirrored traffic is on a
best effort basis where the sidecar/gateway will not wait for the
mirrored cluster to respond before returning the response from the
original destination.  Statistics will be generated for the mirrored
destination.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-mirrors">
<td><code><a href="#HTTPRoute-mirrors">mirrors</a></code></td>
<td><code><a href="#HTTPMirrorPolicy">HTTPMirrorPolicy[]</a></code></td>
<td>
<p>Specifies the destinations to mirror HTTP traffic in addition
to the original destination. Mirrored traffic is on a
best effort basis where the sidecar/gateway will not wait for the
mirrored destinations to respond before returning the response from the
original destination. Statistics will be generated for the mirrored
destination.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-mirror_percentage">
<td><code><a href="#HTTPRoute-mirror_percentage">mirrorPercentage</a></code></td>
<td><code><a href="#Percent">Percent</a></code></td>
<td>
<p>Percentage of the traffic to be mirrored by the <code>mirror</code> field.
If this field is absent, all the traffic (100%) will be mirrored.
Max value is 100.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-cors_policy">
<td><code><a href="#HTTPRoute-cors_policy">corsPolicy</a></code></td>
<td><code><a href="#CorsPolicy">CorsPolicy</a></code></td>
<td>
<p>Cross-Origin Resource Sharing policy (CORS). Refer to
<a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">CORS</a>
for further details about cross origin resource sharing.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-headers">
<td><code><a href="#HTTPRoute-headers">headers</a></code></td>
<td><code><a href="#Headers">Headers</a></code></td>
<td>
<p>Header manipulation rules</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-header_to_dynamic_subset_key">
<td><code><a href="#HTTPRoute-header_to_dynamic_subset_key">headerToDynamicSubsetKey</a></code></td>
<td><code><a href="#HTTPRoute-HeaderToDynamicSubsetKey">HeaderToDynamicSubsetKey[]</a></code></td>
<td>
<p>&mdash; end added by asm &mdash;</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Delegate">Delegate</h2>
<section>
<p>Describes the delegate VirtualService.
The following routing rules forward the traffic to <code>/productpage</code> by a delegate VirtualService named <code>productpage</code>,
forward the traffic to <code>/reviews</code> by a delegate VirtualService named <code>reviews</code>.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: bookinfo
spec:
  hosts:
  - &quot;bookinfo.com&quot;
  gateways:
  - mygateway
  http:
  - match:
    - uri:
        prefix: &quot;/productpage&quot;
    delegate:
       name: productpage
       namespace: nsA
  - match:
    - uri:
        prefix: &quot;/reviews&quot;
    delegate:
        name: reviews
        namespace: nsB
</code></pre>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: productpage
  namespace: nsA
spec:
  http:
  - match:
     - uri:
        prefix: &quot;/productpage/v1/&quot;
    route:
    - destination:
        host: productpage-v1.nsA.svc.cluster.local
  - route:
    - destination:
        host: productpage.nsA.svc.cluster.local
</code></pre>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews
  namespace: nsB
spec:
  http:
  - route:
    - destination:
        host: reviews.nsB.svc.cluster.local
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="Delegate-name">
<td><code><a href="#Delegate-name">name</a></code></td>
<td><code>string</code></td>
<td>
<p>Name specifies the name of the delegate VirtualService.</p>

</td>
<td>
No
</td>
</tr>
<tr id="Delegate-namespace">
<td><code><a href="#Delegate-namespace">namespace</a></code></td>
<td><code>string</code></td>
<td>
<p>Namespace specifies the namespace where the delegate VirtualService resides.
By default, it is same to the root&rsquo;s.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Headers">Headers</h2>
<section>
<p>Message headers can be manipulated when Envoy forwards requests to,
or responses from, a destination service. Header manipulation rules can
be specified for a specific route destination or for all destinations.
The following VirtualService adds a <code>test</code> header with the value <code>true</code>
to requests that are routed to any <code>reviews</code> service destination.
It also removes the <code>foo</code> response header, but only from responses
coming from the <code>v1</code> subset (version) of the <code>reviews</code> service.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route
spec:
  hosts:
  - reviews.prod.svc.cluster.local
  http:
  - headers:
      request:
        set:
          test: &quot;true&quot;
    route:
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v2
      weight: 25
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v1
      headers:
        response:
          remove:
          - foo
      weight: 75
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="Headers-request">
<td><code><a href="#Headers-request">request</a></code></td>
<td><code><a href="#Headers-HeaderOperations">HeaderOperations</a></code></td>
<td>
<p>Header manipulation rules to apply before forwarding a request
to the destination service</p>

</td>
<td>
No
</td>
</tr>
<tr id="Headers-response">
<td><code><a href="#Headers-response">response</a></code></td>
<td><code><a href="#Headers-HeaderOperations">HeaderOperations</a></code></td>
<td>
<p>Header manipulation rules to apply before returning a response
to the caller</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="TLSRoute">TLSRoute</h2>
<section>
<p>Describes match conditions and actions for routing unterminated TLS
traffic (TLS/HTTPS) The following routing rule forwards unterminated TLS
traffic arriving at port 443 of gateway called &ldquo;mygateway&rdquo; to internal
services in the mesh based on the SNI value.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: bookinfo-sni
spec:
  hosts:
  - &quot;*.bookinfo.com&quot;
  gateways:
  - mygateway
  tls:
  - match:
    - port: 443
      sniHosts:
      - login.bookinfo.com
    route:
    - destination:
        host: login.prod.svc.cluster.local
  - match:
    - port: 443
      sniHosts:
      - reviews.bookinfo.com
    route:
    - destination:
        host: reviews.prod.svc.cluster.local
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="TLSRoute-match">
<td><code><a href="#TLSRoute-match">match</a></code></td>
<td><code><a href="#TLSMatchAttributes">TLSMatchAttributes[]</a></code></td>
<td>
<p>Match conditions to be satisfied for the rule to be
activated. All conditions inside a single match block have AND
semantics, while the list of match blocks have OR semantics. The rule
is matched if any one of the match blocks succeed.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="TLSRoute-route">
<td><code><a href="#TLSRoute-route">route</a></code></td>
<td><code><a href="#RouteDestination">RouteDestination[]</a></code></td>
<td>
<p>The destination to which the connection should be forwarded to.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="TCPRoute">TCPRoute</h2>
<section>
<p>Describes match conditions and actions for routing TCP traffic. The
following routing rule forwards traffic arriving at port 27017 for
mongo.prod.svc.cluster.local to another Mongo server on port 5555.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: bookinfo-mongo
spec:
  hosts:
  - mongo.prod.svc.cluster.local
  tcp:
  - match:
    - port: 27017
    route:
    - destination:
        host: mongo.backup.svc.cluster.local
        port:
          number: 5555
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="TCPRoute-match">
<td><code><a href="#TCPRoute-match">match</a></code></td>
<td><code><a href="#L4MatchAttributes">L4MatchAttributes[]</a></code></td>
<td>
<p>Match conditions to be satisfied for the rule to be
activated. All conditions inside a single match block have AND
semantics, while the list of match blocks have OR semantics. The rule
is matched if any one of the match blocks succeed.</p>

</td>
<td>
No
</td>
</tr>
<tr id="TCPRoute-route">
<td><code><a href="#TCPRoute-route">route</a></code></td>
<td><code><a href="#RouteDestination">RouteDestination[]</a></code></td>
<td>
<p>The destination to which the connection should be forwarded to.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPMatchRequest">HTTPMatchRequest</h2>
<section>
<p>HttpMatchRequest specifies a set of criteria to be met in order for the
rule to be applied to the HTTP request. For example, the following
restricts the rule to match only requests where the URL path
starts with /ratings/v2/ and the request contains a custom <code>end-user</code> header
with value <code>jason</code>.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - headers:
        end-user:
          exact: jason
      uri:
        prefix: &quot;/ratings/v2/&quot;
      ignoreUriCase: true
    route:
    - destination:
        host: ratings.prod.svc.cluster.local
</code></pre>
<p>HTTPMatchRequest CANNOT be empty.
<strong>Note:</strong></p>
<ol>
<li>If a root VirtualService have matched any property (path, header etc.) by regex, delegate VirtualServices should not have any other matches on the same property.</li>
<li>If a delegate VirtualService have matched any property (path, header etc.) by regex, root VirtualServices should not have any other matches on the same property.</li>
</ol>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPMatchRequest-name">
<td><code><a href="#HTTPMatchRequest-name">name</a></code></td>
<td><code>string</code></td>
<td>
<p>The name assigned to a match. The match&rsquo;s name will be
concatenated with the parent route&rsquo;s name and will be logged in
the access logs for requests matching this route.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-uri">
<td><code><a href="#HTTPMatchRequest-uri">uri</a></code></td>
<td><code><a href="#StringMatch">StringMatch</a></code></td>
<td>
<p>URI to match
values are case-sensitive and formatted as follows:</p>
<ul>
<li>
<p><code>exact: &quot;value&quot;</code> for exact string match</p>
</li>
<li>
<p><code>prefix: &quot;value&quot;</code> for prefix-based match</p>
</li>
<li>
<p><code>regex: &quot;value&quot;</code> for <a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
</li>
</ul>
<p><strong>Note:</strong> Case-insensitive matching could be enabled via the
<code>ignoreUriCase</code> flag.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-scheme">
<td><code><a href="#HTTPMatchRequest-scheme">scheme</a></code></td>
<td><code><a href="#StringMatch">StringMatch</a></code></td>
<td>
<p>URI Scheme
values are case-sensitive and formatted as follows:</p>
<ul>
<li>
<p><code>exact: &quot;value&quot;</code> for exact string match</p>
</li>
<li>
<p><code>prefix: &quot;value&quot;</code> for prefix-based match</p>
</li>
<li>
<p><code>regex: &quot;value&quot;</code> for <a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
</li>
</ul>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-method">
<td><code><a href="#HTTPMatchRequest-method">method</a></code></td>
<td><code><a href="#StringMatch">StringMatch</a></code></td>
<td>
<p>HTTP Method
values are case-sensitive and formatted as follows:</p>
<ul>
<li>
<p><code>exact: &quot;value&quot;</code> for exact string match</p>
</li>
<li>
<p><code>prefix: &quot;value&quot;</code> for prefix-based match</p>
</li>
<li>
<p><code>regex: &quot;value&quot;</code> for <a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
</li>
</ul>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-authority">
<td><code><a href="#HTTPMatchRequest-authority">authority</a></code></td>
<td><code><a href="#StringMatch">StringMatch</a></code></td>
<td>
<p>HTTP Authority
values are case-sensitive and formatted as follows:</p>
<ul>
<li>
<p><code>exact: &quot;value&quot;</code> for exact string match</p>
</li>
<li>
<p><code>prefix: &quot;value&quot;</code> for prefix-based match</p>
</li>
<li>
<p><code>regex: &quot;value&quot;</code> for <a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
</li>
</ul>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-headers">
<td><code><a href="#HTTPMatchRequest-headers">headers</a></code></td>
<td><code>map&lt;string,&nbsp;<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>The header keys must be lowercase and use hyphen as the separator,
e.g. <em>x-request-id</em>.</p>
<p>Header values are case-sensitive and formatted as follows:</p>
<ul>
<li>
<p><code>exact: &quot;value&quot;</code> for exact string match</p>
</li>
<li>
<p><code>prefix: &quot;value&quot;</code> for prefix-based match</p>
</li>
<li>
<p><code>regex: &quot;value&quot;</code> for <a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
</li>
</ul>
<p>If the value is empty and only the name of header is specified, presence of the header is checked.
To provide an empty value, use <code>{}</code>, for example:</p>
<pre><code> - match:
   - headers:
       myheader: {}
</code></pre>
<p><strong>Note:</strong> The keys <code>uri</code>, <code>scheme</code>, <code>method</code>, and <code>authority</code> will be ignored.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-port">
<td><code><a href="#HTTPMatchRequest-port">port</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Specifies the ports on the host that is being addressed. Many services
only expose a single port or label ports with the protocols they support,
in these cases it is not required to explicitly select the port.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-source_labels">
<td><code><a href="#HTTPMatchRequest-source_labels">sourceLabels</a></code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>One or more labels that constrain the applicability of a rule to source (client) workloads
with the given labels. If the VirtualService has a list of gateways specified
in the top-level <code>gateways</code> field, it must include the reserved gateway
<code>mesh</code> for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-gateways">
<td><code><a href="#HTTPMatchRequest-gateways">gateways</a></code></td>
<td><code>string[]</code></td>
<td>
<p>Names of gateways where the rule should be applied. Gateway names
in the top-level <code>gateways</code> field of the VirtualService (if any) are overridden. The gateway
match is independent of sourceLabels.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-query_params">
<td><code><a href="#HTTPMatchRequest-query_params">queryParams</a></code></td>
<td><code>map&lt;string,&nbsp;<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>Query parameters for matching.</p>
<p>Ex:</p>
<ul>
<li>
<p>For a query parameter like &ldquo;?key=true&rdquo;, the map key would be &ldquo;key&rdquo; and
the string match could be defined as <code>exact: &quot;true&quot;</code>.</p>
</li>
<li>
<p>For a query parameter like &ldquo;?key&rdquo;, the map key would be &ldquo;key&rdquo; and the
string match could be defined as <code>exact: &quot;&quot;</code>.</p>
</li>
<li>
<p>For a query parameter like &ldquo;?key=abc&rdquo; or &ldquo;?key=abx&rdquo;, the map key would be &ldquo;key&rdquo; and the
string match could be defined as <code>prefix: &quot;ab&quot;</code>.</p>
</li>
<li>
<p>For a query parameter like &ldquo;?key=123&rdquo;, the map key would be &ldquo;key&rdquo; and the
string match could be defined as <code>regex: &quot;\d+$&quot;</code>. Note that this
configuration will only match values like &ldquo;123&rdquo; but not &ldquo;a123&rdquo; or &ldquo;123a&rdquo;.</p>
</li>
</ul>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-ignore_uri_case">
<td><code><a href="#HTTPMatchRequest-ignore_uri_case">ignoreUriCase</a></code></td>
<td><code>bool</code></td>
<td>
<p>Flag to specify whether the URI matching should be case-insensitive.</p>
<p><strong>Note:</strong> The case will be ignored only in the case of <code>exact</code> and <code>prefix</code>
URI matches.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-without_headers">
<td><code><a href="#HTTPMatchRequest-without_headers">withoutHeaders</a></code></td>
<td><code>map&lt;string,&nbsp;<a href="#StringMatch">StringMatch</a>&gt;</code></td>
<td>
<p>withoutHeader has the same syntax with the header, but has opposite meaning.
If a header is matched with a matching rule among withoutHeader, the traffic becomes not matched one.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-source_namespace">
<td><code><a href="#HTTPMatchRequest-source_namespace">sourceNamespace</a></code></td>
<td><code>string</code></td>
<td>
<p>Source namespace constraining the applicability of a rule to workloads in that namespace.
If the VirtualService has a list of gateways specified in the top-level <code>gateways</code> field,
it must include the reserved gateway <code>mesh</code> for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPMatchRequest-stat_prefix">
<td><code><a href="#HTTPMatchRequest-stat_prefix">statPrefix</a></code></td>
<td><code>string</code></td>
<td>
<p>The human readable prefix to use when emitting statistics for this route.
The statistics are generated with prefix route.&lt;stat_prefix&gt;.
This should be set for highly critical routes that one wishes to get &ldquo;per-route&rdquo; statistics on.
This prefix is only for proxy-level statistics (envoy_<em>) and not service-level (istio_</em>) statistics.
Refer to <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-field-config-route-v3-route-stat-prefix">https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#envoy-v3-api-field-config-route-v3-route-stat-prefix</a>
for statistics that are generated when this is configured.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRouteDestination">HTTPRouteDestination</h2>
<section>
<p>Each routing rule is associated with one or more service versions (see
glossary in beginning of document). Weights associated with the version
determine the proportion of traffic it receives. For example, the
following rule will route 25% of traffic for the &ldquo;reviews&rdquo; service to
instances with the &ldquo;v2&rdquo; tag and the remaining traffic (i.e., 75%) to
&ldquo;v1&rdquo;.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route
spec:
  hosts:
  - reviews.prod.svc.cluster.local
  http:
  - route:
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v2
      weight: 25
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v1
      weight: 75
</code></pre>
<p>And the associated DestinationRule</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: DestinationRule
metadata:
  name: reviews-destination
spec:
  host: reviews.prod.svc.cluster.local
  subsets:
  - name: v1
    labels:
      version: v1
  - name: v2
    labels:
      version: v2
</code></pre>
<p>Traffic can also be split across two entirely different services without
having to define new subsets. For example, the following rule forwards 25% of
traffic to reviews.com to dev.reviews.com</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route-two-domains
spec:
  hosts:
  - reviews.com
  http:
  - route:
    - destination:
        host: dev.reviews.com
      weight: 25
    - destination:
        host: reviews.com
      weight: 75
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRouteDestination-destination">
<td><code><a href="#HTTPRouteDestination-destination">destination</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>Destination uniquely identifies the instances of a service
to which the request/connection should be forwarded to.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="HTTPRouteDestination-weight">
<td><code><a href="#HTTPRouteDestination-weight">weight</a></code></td>
<td><code>int32</code></td>
<td>
<p>Weight specifies the relative proportion of traffic to be forwarded to the destination. A destination will receive <code>weight/(sum of all weights)</code> requests.
If there is only one destination in a rule, it will receive all traffic.
Otherwise, if weight is <code>0</code>, the destination will not receive any traffic.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRouteDestination-headers">
<td><code><a href="#HTTPRouteDestination-headers">headers</a></code></td>
<td><code><a href="#Headers">Headers</a></code></td>
<td>
<p>Header manipulation rules</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRouteDestination-fallback">
<td><code><a href="#HTTPRouteDestination-fallback">fallback</a></code></td>
<td><code><a href="#HTTPRouteFallback">HTTPRouteFallback</a></code></td>
<td>
<p>Added by Alibaba Cloud Service Mesh (ASM)</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRouteFallbackTarget">HTTPRouteFallbackTarget</h2>
<section>
<p>Added by Alibaba Cloud Service Mesh (ASM)
Fall back for HTTP Route</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRouteFallbackTarget-destination">
<td><code><a href="#HTTPRouteFallbackTarget-destination">destination</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
</td>
<td>
No
</td>
</tr>
<tr id="HTTPRouteFallbackTarget-host_rewrite">
<td><code><a href="#HTTPRouteFallbackTarget-host_rewrite">hostRewrite</a></code></td>
<td><code>bool</code></td>
<td>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRouteFallback">HTTPRouteFallback</h2>
<section>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRouteFallback-case">
<td><code><a href="#HTTPRouteFallback-case">case</a></code></td>
<td><code>string</code></td>
<td>
</td>
<td>
No
</td>
</tr>
<tr id="HTTPRouteFallback-target">
<td><code><a href="#HTTPRouteFallback-target">target</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
</td>
<td>
No
</td>
</tr>
<tr id="HTTPRouteFallback-targets">
<td><code><a href="#HTTPRouteFallback-targets">targets</a></code></td>
<td><code><a href="#HTTPRouteFallbackTarget">HTTPRouteFallbackTarget[]</a></code></td>
<td>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="RouteDestination">RouteDestination</h2>
<section>
<p>L4 routing rule weighted destination.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="RouteDestination-destination">
<td><code><a href="#RouteDestination-destination">destination</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>Destination uniquely identifies the instances of a service
to which the request/connection should be forwarded to.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="RouteDestination-weight">
<td><code><a href="#RouteDestination-weight">weight</a></code></td>
<td><code>int32</code></td>
<td>
<p>Weight specifies the relative proportion of traffic to be forwarded to the destination. A destination will receive <code>weight/(sum of all weights)</code> requests.
If there is only one destination in a rule, it will receive all traffic.
Otherwise, if weight is <code>0</code>, the destination will not receive any traffic.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="L4MatchAttributes">L4MatchAttributes</h2>
<section>
<p>L4 connection match attributes. Note that L4 connection matching support
is incomplete.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="L4MatchAttributes-destination_subnets">
<td><code><a href="#L4MatchAttributes-destination_subnets">destinationSubnets</a></code></td>
<td><code>string[]</code></td>
<td>
<p>IPv4 or IPv6 ip addresses of destination with optional subnet.  E.g.,
a.b.c.d/xx form or just a.b.c.d.</p>

</td>
<td>
No
</td>
</tr>
<tr id="L4MatchAttributes-port">
<td><code><a href="#L4MatchAttributes-port">port</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Specifies the port on the host that is being addressed. Many services
only expose a single port or label ports with the protocols they support,
in these cases it is not required to explicitly select the port.</p>

</td>
<td>
No
</td>
</tr>
<tr id="L4MatchAttributes-source_labels">
<td><code><a href="#L4MatchAttributes-source_labels">sourceLabels</a></code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>One or more labels that constrain the applicability of a rule to
workloads with the given labels. If the VirtualService has a list of
gateways specified in the top-level <code>gateways</code> field, it should include the reserved gateway
<code>mesh</code> in order for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
<tr id="L4MatchAttributes-gateways">
<td><code><a href="#L4MatchAttributes-gateways">gateways</a></code></td>
<td><code>string[]</code></td>
<td>
<p>Names of gateways where the rule should be applied. Gateway names
in the top-level <code>gateways</code> field of the VirtualService (if any) are overridden. The gateway
match is independent of sourceLabels.</p>

</td>
<td>
No
</td>
</tr>
<tr id="L4MatchAttributes-source_namespace">
<td><code><a href="#L4MatchAttributes-source_namespace">sourceNamespace</a></code></td>
<td><code>string</code></td>
<td>
<p>Source namespace constraining the applicability of a rule to workloads in that namespace.
If the VirtualService has a list of gateways specified in the top-level <code>gateways</code> field,
it must include the reserved gateway <code>mesh</code> for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="TLSMatchAttributes">TLSMatchAttributes</h2>
<section>
<p>TLS connection match attributes.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="TLSMatchAttributes-sni_hosts">
<td><code><a href="#TLSMatchAttributes-sni_hosts">sniHosts</a></code></td>
<td><code>string[]</code></td>
<td>
<p>SNI (server name indicator) to match on. Wildcard prefixes
can be used in the SNI value, e.g., *.com will match foo.example.com
as well as example.com. An SNI value must be a subset (i.e., fall
within the domain) of the corresponding virtual service&rsquo;s hosts.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="TLSMatchAttributes-destination_subnets">
<td><code><a href="#TLSMatchAttributes-destination_subnets">destinationSubnets</a></code></td>
<td><code>string[]</code></td>
<td>
<p>IPv4 or IPv6 ip addresses of destination with optional subnet.  E.g.,
a.b.c.d/xx form or just a.b.c.d.</p>

</td>
<td>
No
</td>
</tr>
<tr id="TLSMatchAttributes-port">
<td><code><a href="#TLSMatchAttributes-port">port</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Specifies the port on the host that is being addressed. Many services
only expose a single port or label ports with the protocols they
support, in these cases it is not required to explicitly select the
port.</p>

</td>
<td>
No
</td>
</tr>
<tr id="TLSMatchAttributes-source_labels">
<td><code><a href="#TLSMatchAttributes-source_labels">sourceLabels</a></code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>One or more labels that constrain the applicability of a rule to
workloads with the given labels. If the VirtualService has a list of
gateways specified in the top-level <code>gateways</code> field, it should include the reserved gateway
<code>mesh</code> in order for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
<tr id="TLSMatchAttributes-gateways">
<td><code><a href="#TLSMatchAttributes-gateways">gateways</a></code></td>
<td><code>string[]</code></td>
<td>
<p>Names of gateways where the rule should be applied. Gateway names
in the top-level <code>gateways</code> field of the VirtualService (if any) are overridden. The gateway
match is independent of sourceLabels.</p>

</td>
<td>
No
</td>
</tr>
<tr id="TLSMatchAttributes-source_namespace">
<td><code><a href="#TLSMatchAttributes-source_namespace">sourceNamespace</a></code></td>
<td><code>string</code></td>
<td>
<p>Source namespace constraining the applicability of a rule to workloads in that namespace.
If the VirtualService has a list of gateways specified in the top-level <code>gateways</code> field,
it must include the reserved gateway <code>mesh</code> for this field to be applicable.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRedirect">HTTPRedirect</h2>
<section>
<p>HTTPRedirect can be used to send a 301 redirect response to the caller,
where the Authority/Host and the URI in the response can be swapped with
the specified values. For example, the following rule redirects
requests for /v1/getProductRatings API on the ratings service to
/v1/bookRatings provided by the bookratings service.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - uri:
        exact: /v1/getProductRatings
    redirect:
      uri: /v1/bookRatings
      authority: newratings.default.svc.cluster.local
  ...
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRedirect-uri">
<td><code><a href="#HTTPRedirect-uri">uri</a></code></td>
<td><code>string</code></td>
<td>
<p>On a redirect, overwrite the Path portion of the URL with this
value. Note that the entire path will be replaced, irrespective of the
request URI being matched as an exact path or prefix.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRedirect-authority">
<td><code><a href="#HTTPRedirect-authority">authority</a></code></td>
<td><code>string</code></td>
<td>
<p>On a redirect, overwrite the Authority/Host portion of the URL with
this value.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRedirect-port" class="oneof oneof-start">
<td><code><a href="#HTTPRedirect-port">port</a></code></td>
<td><code>uint32 (oneof)</code></td>
<td>
<p>On a redirect, overwrite the port portion of the URL with this value.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRedirect-derive_port" class="oneof">
<td><code><a href="#HTTPRedirect-derive_port">derivePort</a></code></td>
<td><code><a href="#HTTPRedirect-RedirectPortSelection">RedirectPortSelection (oneof)</a></code></td>
<td>
<p>On a redirect, dynamically set the port:</p>
<ul>
<li>FROM_PROTOCOL_DEFAULT: automatically set to 80 for HTTP and 443 for HTTPS.</li>
<li>FROM_REQUEST_PORT: automatically use the port of the request.</li>
</ul>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRedirect-scheme">
<td><code><a href="#HTTPRedirect-scheme">scheme</a></code></td>
<td><code>string</code></td>
<td>
<p>On a redirect, overwrite the scheme portion of the URL with this value.
For example, <code>http</code> or <code>https</code>.
If unset, the original scheme will be used.
If <code>derivePort</code> is set to <code>FROM_PROTOCOL_DEFAULT</code>, this will impact the port used as well</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRedirect-redirect_code">
<td><code><a href="#HTTPRedirect-redirect_code">redirectCode</a></code></td>
<td><code>uint32</code></td>
<td>
<p>On a redirect, Specifies the HTTP status code to use in the redirect
response. The default response code is MOVED_PERMANENTLY (301).</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPDirectResponse">HTTPDirectResponse</h2>
<section>
<p>HTTPDirectResponse can be used to send a fixed response to clients.
For example, the following rule returns a fixed 503 status with a body
to requests for /v1/getProductRatings API.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - uri:
        exact: /v1/getProductRatings
    directResponse:
      status: 503
      body:
        string: &quot;unknown error&quot;
  ...
</code></pre>
<p>It is also possible to specify a binary response body.
This is mostly useful for non text-based protocols such as gRPC.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - uri:
        exact: /v1/getProductRatings
    directResponse:
      status: 503
      body:
        bytes: &quot;dW5rbm93biBlcnJvcg==&quot; # &quot;unknown error&quot; in base64
  ...
</code></pre>
<p>It is good practice to add headers in the HTTPRoute
as well as the direct_response, for example to specify
the returned Content-Type.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - uri:
        exact: /v1/getProductRatings
    directResponse:
      status: 503
      body:
        string: &quot;{\&quot;error\&quot;: \&quot;unknown error\&quot;}&quot;
    headers:
      response:
        set:
          content-type: &quot;text/plain&quot;
  ...
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPDirectResponse-status">
<td><code><a href="#HTTPDirectResponse-status">status</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Specifies the HTTP response status to be returned.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="HTTPDirectResponse-body">
<td><code><a href="#HTTPDirectResponse-body">body</a></code></td>
<td><code><a href="#HTTPBody">HTTPBody</a></code></td>
<td>
<p>Specifies the content of the response body. If this setting is omitted,
no body is included in the generated response.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPBody">HTTPBody</h2>
<section>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPBody-string" class="oneof oneof-start">
<td><code><a href="#HTTPBody-string">string</a></code></td>
<td><code>string (oneof)</code></td>
<td>
<p>response body as a string</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPBody-bytes" class="oneof">
<td><code><a href="#HTTPBody-bytes">bytes</a></code></td>
<td><code>bytes (oneof)</code></td>
<td>
<p>response body as base64 encoded bytes.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRewrite">HTTPRewrite</h2>
<section>
<p>HTTPRewrite can be used to rewrite specific parts of a HTTP request
before forwarding the request to the destination. Rewrite primitive can
be used only with HTTPRouteDestination. The following example
demonstrates how to rewrite the URL prefix for api call (/ratings) to
ratings service before making the actual API call.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - match:
    - uri:
        prefix: /ratings
    rewrite:
      uri: /v1/bookRatings
    route:
    - destination:
        host: ratings.prod.svc.cluster.local
        subset: v1
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRewrite-uri">
<td><code><a href="#HTTPRewrite-uri">uri</a></code></td>
<td><code>string</code></td>
<td>
<p>rewrite the path (or the prefix) portion of the URI with this
value. If the original URI was matched based on prefix, the value
provided in this field will replace the corresponding matched prefix.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRewrite-authority">
<td><code><a href="#HTTPRewrite-authority">authority</a></code></td>
<td><code>string</code></td>
<td>
<p>rewrite the Authority/Host header with this value.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRewrite-uri_regex_rewrite">
<td><code><a href="#HTTPRewrite-uri_regex_rewrite">uriRegexRewrite</a></code></td>
<td><code><a href="#RegexRewrite">RegexRewrite</a></code></td>
<td>
<p>rewrite the path portion of the URI with the specified regex.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="RegexRewrite">RegexRewrite</h2>
<section>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="RegexRewrite-match">
<td><code><a href="#RegexRewrite-match">match</a></code></td>
<td><code>string</code></td>
<td>
<p><a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>

</td>
<td>
No
</td>
</tr>
<tr id="RegexRewrite-rewrite">
<td><code><a href="#RegexRewrite-rewrite">rewrite</a></code></td>
<td><code>string</code></td>
<td>
<p>The string that should replace into matching portions of original URI.
Capture groups in the pattern can be referenced in the new URI.
Examples:</p>
<p>Example 1: rewrite with capture groups
Path pattern &ldquo;/service/update/v1/api&rdquo; with match &ldquo;^/service/([^/]+)(/.*)$&rdquo; and
rewrite string of &ldquo;/customprefix/\2/\1&rdquo; would transform into &ldquo;/customprefix/v1/api/update&rdquo;.</p>
<p>Example 2: case insensitive rewrite
Path pattern &ldquo;/aaa/XxX/bbb&rdquo; with match &ldquo;(?i)/xxx/&rdquo; and a rewrite string of /yyy/ would do a
case-insensitive match and transform the path to &ldquo;/aaa/yyy/bbb&rdquo;.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="StringMatch">StringMatch</h2>
<section>
<p>Describes how to match a given string in HTTP headers. <code>exact</code> and <code>prefix</code> matching is
case-sensitive. <code>regex</code> matching supports case-insensitive matches.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="StringMatch-exact" class="oneof oneof-start">
<td><code><a href="#StringMatch-exact">exact</a></code></td>
<td><code>string (oneof)</code></td>
<td>
<p>exact string match</p>

</td>
<td>
No
</td>
</tr>
<tr id="StringMatch-prefix" class="oneof">
<td><code><a href="#StringMatch-prefix">prefix</a></code></td>
<td><code>string (oneof)</code></td>
<td>
<p>prefix-based match</p>

</td>
<td>
No
</td>
</tr>
<tr id="StringMatch-regex" class="oneof">
<td><code><a href="#StringMatch-regex">regex</a></code></td>
<td><code>string (oneof)</code></td>
<td>
<p><a href="https://github.com/google/re2/wiki/Syntax">RE2 style regex-based match</a>.</p>
<p>Example: <code>(?i)^aaa$</code> can be used to case-insensitive match a string consisting of three a&rsquo;s.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRetry">HTTPRetry</h2>
<section>
<p>Describes the retry policy to use when a HTTP request fails. For
example, the following rule sets the maximum number of retries to 3 when
calling ratings:v1 service, with a 2s timeout per retry attempt.
A retry will be attempted if there is a connect-failure, refused_stream
or when the upstream server responds with Service Unavailable(503).</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - route:
    - destination:
        host: ratings.prod.svc.cluster.local
        subset: v1
    retries:
      attempts: 3
      perTryTimeout: 2s
      retryOn: gateway-error,connect-failure,refused-stream
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRetry-attempts">
<td><code><a href="#HTTPRetry-attempts">attempts</a></code></td>
<td><code>int32</code></td>
<td>
<p>Number of retries to be allowed for a given request. The interval
between retries will be determined automatically (25ms+). When request
<code>timeout</code> of the <a href="https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRoute">HTTP route</a>
or <code>per_try_timeout</code> is configured, the actual number of retries attempted also depends on
the specified request <code>timeout</code> and <code>per_try_timeout</code> values. MUST BE &gt;= 0. If <code>0</code>, retries will be disabled.
The maximum possible number of requests made will be 1 + <code>attempts</code>.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRetry-per_try_timeout">
<td><code><a href="#HTTPRetry-per_try_timeout">perTryTimeout</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
<td>
<p>Timeout per attempt for a given request, including the initial call and any retries. Format: 1h/1m/1s/1ms. MUST BE &gt;=1ms.
Default is same value as request
<code>timeout</code> of the <a href="https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRoute">HTTP route</a>,
which means no timeout.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRetry-retry_on">
<td><code><a href="#HTTPRetry-retry_on">retryOn</a></code></td>
<td><code>string</code></td>
<td>
<p>Specifies the conditions under which retry takes place.
One or more policies can be specified using a ‘,’ delimited list.
See the <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on">retry policies</a>
and <a href="https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on">gRPC retry policies</a> for more details.</p>
<p>In addition to the policies specified above, a list of HTTP status codes can be passed, such as <code>retryOn: &quot;503,reset&quot;</code>.
Note these status codes refer to the actual responses received from the destination.
For example, if a connection is reset, Istio will translate this to 503 for it&rsquo;s response.
However, the destination did not return a 503 error, so this would not match <code>&quot;503&quot;</code> (it would, however, match <code>&quot;reset&quot;</code>).</p>
<p>If not specified, this defaults to <code>connect-failure,refused-stream,unavailable,cancelled,503</code>.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPRetry-retry_remote_localities">
<td><code><a href="#HTTPRetry-retry_remote_localities">retryRemoteLocalities</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue">BoolValue</a></code></td>
<td>
<p>Flag to specify whether the retries should retry to other localities.
See the <a href="https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/http/http_connection_management#retry-plugin-configuration">retry plugin configuration</a> for more details.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="CorsPolicy">CorsPolicy</h2>
<section>
<p>Describes the Cross-Origin Resource Sharing (CORS) policy, for a given
service. Refer to <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS">CORS</a>
for further details about cross origin resource sharing. For example,
the following rule restricts cross origin requests to those originating
from example.com domain using HTTP POST/GET, and sets the
<code>Access-Control-Allow-Credentials</code> header to false. In addition, it only
exposes <code>X-Foo-bar</code> header and sets an expiry period of 1 day.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - route:
    - destination:
        host: ratings.prod.svc.cluster.local
        subset: v1
    corsPolicy:
      allowOrigins:
      - exact: https://example.com
      allowMethods:
      - POST
      - GET
      allowCredentials: false
      allowHeaders:
      - X-Foo-Bar
      maxAge: &quot;24h&quot;
</code></pre>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="CorsPolicy-allow_origins">
<td><code><a href="#CorsPolicy-allow_origins">allowOrigins</a></code></td>
<td><code><a href="#StringMatch">StringMatch[]</a></code></td>
<td>
<p>String patterns that match allowed origins.
An origin is allowed if any of the string matchers match.
If a match is found, then the outgoing Access-Control-Allow-Origin would be set to the origin as provided by the client.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-allow_methods">
<td><code><a href="#CorsPolicy-allow_methods">allowMethods</a></code></td>
<td><code>string[]</code></td>
<td>
<p>List of HTTP methods allowed to access the resource. The content will
be serialized into the Access-Control-Allow-Methods header.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-allow_headers">
<td><code><a href="#CorsPolicy-allow_headers">allowHeaders</a></code></td>
<td><code>string[]</code></td>
<td>
<p>List of HTTP headers that can be used when requesting the
resource. Serialized to Access-Control-Allow-Headers header.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-expose_headers">
<td><code><a href="#CorsPolicy-expose_headers">exposeHeaders</a></code></td>
<td><code>string[]</code></td>
<td>
<p>A list of HTTP headers that the browsers are allowed to
access. Serialized into Access-Control-Expose-Headers header.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-max_age">
<td><code><a href="#CorsPolicy-max_age">maxAge</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
<td>
<p>Specifies how long the results of a preflight request can be
cached. Translates to the <code>Access-Control-Max-Age</code> header.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-allow_credentials">
<td><code><a href="#CorsPolicy-allow_credentials">allowCredentials</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue">BoolValue</a></code></td>
<td>
<p>Indicates whether the caller is allowed to send the actual request
(not the preflight) using credentials. Translates to
<code>Access-Control-Allow-Credentials</code> header.</p>

</td>
<td>
No
</td>
</tr>
<tr id="CorsPolicy-unmatched_preflights">
<td><code><a href="#CorsPolicy-unmatched_preflights">unmatchedPreflights</a></code></td>
<td><code><a href="#CorsPolicy-UnmatchedPreflights">UnmatchedPreflights</a></code></td>
<td>
<p>Indicates whether preflight requests not matching the configured
allowed origin shouldn&rsquo;t be forwarded to the upstream.
Default is forward to upstream.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPFaultInjection">HTTPFaultInjection</h2>
<section>
<p>HTTPFaultInjection can be used to specify one or more faults to inject
while forwarding HTTP requests to the destination specified in a route.
Fault specification is part of a VirtualService rule. Faults include
aborting the Http request from downstream service, and/or delaying
proxying of requests. A fault rule MUST HAVE delay or abort or both.</p>
<p><em>Note:</em> Delay and abort faults are independent of one another, even if
both are specified simultaneously.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPFaultInjection-delay">
<td><code><a href="#HTTPFaultInjection-delay">delay</a></code></td>
<td><code><a href="#HTTPFaultInjection-Delay">Delay</a></code></td>
<td>
<p>Delay requests before forwarding, emulating various failures such as
network issues, overloaded upstream service, etc.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPFaultInjection-abort">
<td><code><a href="#HTTPFaultInjection-abort">abort</a></code></td>
<td><code><a href="#HTTPFaultInjection-Abort">Abort</a></code></td>
<td>
<p>Abort Http request attempts and return error codes back to downstream
service, giving the impression that the upstream service is faulty.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPMirrorPolicy">HTTPMirrorPolicy</h2>
<section>
<p>HTTPMirrorPolicy can be used to specify the destinations to mirror HTTP traffic in addition
to the original destination. Mirrored traffic is on a
best effort basis where the sidecar/gateway will not wait for the
mirrored destinations to respond before returning the response from the
original destination. Statistics will be generated for the mirrored
destination.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPMirrorPolicy-destination">
<td><code><a href="#HTTPMirrorPolicy-destination">destination</a></code></td>
<td><code><a href="#Destination">Destination</a></code></td>
<td>
<p>Destination specifies the target of the mirror operation.</p>

</td>
<td>
Yes
</td>
</tr>
<tr id="HTTPMirrorPolicy-percentage">
<td><code><a href="#HTTPMirrorPolicy-percentage">percentage</a></code></td>
<td><code><a href="#Percent">Percent</a></code></td>
<td>
<p>Percentage of the traffic to be mirrored by the <code>destination</code> field.
If this field is absent, all the traffic (100%) will be mirrored.
Max value is 100.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="PortSelector">PortSelector</h2>
<section>
<p>PortSelector specifies the number of a port to be used for
matching or selection for final routing.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="PortSelector-number">
<td><code><a href="#PortSelector-number">number</a></code></td>
<td><code>uint32</code></td>
<td>
<p>Valid port number</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Percent">Percent</h2>
<section>
<p>Percent specifies a percentage in the range of [0.0, 100.0].</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="Percent-value">
<td><code><a href="#Percent-value">value</a></code></td>
<td><code>double</code></td>
<td>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRoute-HeaderToDynamicSubsetKey">HTTPRoute.HeaderToDynamicSubsetKey</h2>
<section>
<p>&mdash; added by asm &mdash;</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRoute-HeaderToDynamicSubsetKey-header">
<td><code><a href="#HTTPRoute-HeaderToDynamicSubsetKey-header">header</a></code></td>
<td><code>string</code></td>
<td>
</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-HeaderToDynamicSubsetKey-key">
<td><code><a href="#HTTPRoute-HeaderToDynamicSubsetKey-key">key</a></code></td>
<td><code>string</code></td>
<td>
</td>
<td>
No
</td>
</tr>
<tr id="HTTPRoute-HeaderToDynamicSubsetKey-defaultValue">
<td><code><a href="#HTTPRoute-HeaderToDynamicSubsetKey-defaultValue">defaultValue</a></code></td>
<td><code>string</code></td>
<td>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Headers-HeaderOperations">Headers.HeaderOperations</h2>
<section>
<p>HeaderOperations Describes the header manipulations to apply</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="Headers-HeaderOperations-set">
<td><code><a href="#Headers-HeaderOperations-set">set</a></code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Overwrite the headers specified by key with the given values</p>

</td>
<td>
No
</td>
</tr>
<tr id="Headers-HeaderOperations-add">
<td><code><a href="#Headers-HeaderOperations-add">add</a></code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Append the given values to the headers specified by keys
(will create a comma-separated list of values)</p>

</td>
<td>
No
</td>
</tr>
<tr id="Headers-HeaderOperations-remove">
<td><code><a href="#Headers-HeaderOperations-remove">remove</a></code></td>
<td><code>string[]</code></td>
<td>
<p>Remove the specified headers</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPFaultInjection-Delay">HTTPFaultInjection.Delay</h2>
<section>
<p>Delay specification is used to inject latency into the request
forwarding path. The following example will introduce a 5 second delay
in 1 out of every 1000 requests to the &ldquo;v1&rdquo; version of the &ldquo;reviews&rdquo;
service from all pods with label env: prod</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: reviews-route
spec:
  hosts:
  - reviews.prod.svc.cluster.local
  http:
  - match:
    - sourceLabels:
        env: prod
    route:
    - destination:
        host: reviews.prod.svc.cluster.local
        subset: v1
    fault:
      delay:
        percentage:
          value: 0.1
        fixedDelay: 5s
</code></pre>
<p>The <em>fixedDelay</em> field is used to indicate the amount of delay in seconds.
The optional <em>percentage</em> field can be used to only delay a certain
percentage of requests. If left unspecified, no request will be delayed.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPFaultInjection-Delay-fixed_delay" class="oneof oneof-start">
<td><code><a href="#HTTPFaultInjection-Delay-fixed_delay">fixedDelay</a></code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration (oneof)</a></code></td>
<td>
<p>Add a fixed delay before forwarding the request. Format:
1h/1m/1s/1ms. MUST be &gt;=1ms.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPFaultInjection-Delay-percentage">
<td><code><a href="#HTTPFaultInjection-Delay-percentage">percentage</a></code></td>
<td><code><a href="#Percent">Percent</a></code></td>
<td>
<p>Percentage of requests on which the delay will be injected.
If left unspecified, no request will be delayed.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPFaultInjection-Delay-percent" class="deprecated ">
<td><code><a href="#HTTPFaultInjection-Delay-percent">percent</a></code></td>
<td><code>int32</code></td>
<td>
<p>Percentage of requests on which the delay will be injected (0-100).
Use of integer <code>percent</code> value is deprecated. Use the double <code>percentage</code>
field instead.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPFaultInjection-Abort">HTTPFaultInjection.Abort</h2>
<section>
<p>Abort specification is used to prematurely abort a request with a
pre-specified error code. The following example will return an HTTP 400
error code for 1 out of every 1000 requests to the &ldquo;ratings&rdquo; service &ldquo;v1&rdquo;.</p>
<pre><code class="language-yaml">apiVersion: networking.istio.io/v1
kind: VirtualService
metadata:
  name: ratings-route
spec:
  hosts:
  - ratings.prod.svc.cluster.local
  http:
  - route:
    - destination:
        host: ratings.prod.svc.cluster.local
        subset: v1
    fault:
      abort:
        percentage:
          value: 0.1
        httpStatus: 400
</code></pre>
<p>The <em>httpStatus</em> field is used to indicate the HTTP status code to
return to the caller. The optional <em>percentage</em> field can be used to only
abort a certain percentage of requests. If not specified, no request will be
aborted.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="HTTPFaultInjection-Abort-http_status" class="oneof oneof-start">
<td><code><a href="#HTTPFaultInjection-Abort-http_status">httpStatus</a></code></td>
<td><code>int32 (oneof)</code></td>
<td>
<p>HTTP status code to use to abort the Http request.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPFaultInjection-Abort-grpc_status" class="oneof">
<td><code><a href="#HTTPFaultInjection-Abort-grpc_status">grpcStatus</a></code></td>
<td><code>string (oneof)</code></td>
<td>
<p>GRPC status code to use to abort the request. The supported
codes are documented in <a href="https://github.com/grpc/grpc/blob/master/doc/statuscodes.md">https://github.com/grpc/grpc/blob/master/doc/statuscodes.md</a>
Note: If you want to return the status &ldquo;Unavailable&rdquo;, then you should
specify the code as <code>UNAVAILABLE</code>(all caps), but not <code>14</code>.</p>

</td>
<td>
No
</td>
</tr>
<tr id="HTTPFaultInjection-Abort-percentage">
<td><code><a href="#HTTPFaultInjection-Abort-percentage">percentage</a></code></td>
<td><code><a href="#Percent">Percent</a></code></td>
<td>
<p>Percentage of requests to be aborted with the error code provided.
If not specified, no request will be aborted.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="google-protobuf-UInt32Value">google.protobuf.UInt32Value</h2>
<section>
<p>Wrapper message for <code>uint32</code>.</p>
<p>The JSON representation for <code>UInt32Value</code> is JSON number.</p>

<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="google-protobuf-UInt32Value-value">
<td><code><a href="#google-protobuf-UInt32Value-value">value</a></code></td>
<td><code>uint32</code></td>
<td>
<p>The uint32 value.</p>

</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="HTTPRedirect-RedirectPortSelection">HTTPRedirect.RedirectPortSelection</h2>
<section>
<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="HTTPRedirect-RedirectPortSelection-FROM_PROTOCOL_DEFAULT">
<td><code><a href="#HTTPRedirect-RedirectPortSelection-FROM_PROTOCOL_DEFAULT">FROM_PROTOCOL_DEFAULT</a></code></td>
<td>
</td>
</tr>
<tr id="HTTPRedirect-RedirectPortSelection-FROM_REQUEST_PORT">
<td><code><a href="#HTTPRedirect-RedirectPortSelection-FROM_REQUEST_PORT">FROM_REQUEST_PORT</a></code></td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="CorsPolicy-UnmatchedPreflights">CorsPolicy.UnmatchedPreflights</h2>
<section>
<table class="enum-values">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="CorsPolicy-UnmatchedPreflights-UNSPECIFIED">
<td><code><a href="#CorsPolicy-UnmatchedPreflights-UNSPECIFIED">UNSPECIFIED</a></code></td>
<td>
<p>Default to FORWARD</p>

</td>
</tr>
<tr id="CorsPolicy-UnmatchedPreflights-FORWARD">
<td><code><a href="#CorsPolicy-UnmatchedPreflights-FORWARD">FORWARD</a></code></td>
<td>
<p>Preflight requests not matching the configured allowed origin
will be forwarded to the upstream.</p>

</td>
</tr>
<tr id="CorsPolicy-UnmatchedPreflights-IGNORE">
<td><code><a href="#CorsPolicy-UnmatchedPreflights-IGNORE">IGNORE</a></code></td>
<td>
<p>Preflight requests not matching the configured allowed origin
will not be forwarded to the upstream.</p>

</td>
</tr>
</tbody>
</table>
</section>