URL maps overview

Google Cloud HTTP(S) load balancers and Traffic Director use a Google Cloud configuration resource called a URL map to route requests to backend services or backend buckets.

For example, with an external HTTP(S) load balancer, you can use a single URL map to route requests to different destinations based on the rules configured in the URL map:

  • Requests for https://example.com/video go to one backend service.
  • Requests for https://example.com/audio go to a different backend service.
  • Requests for https://example.com/images go to a Cloud Storage backend bucket.
  • Requests for any other host and path combination go to a default backend service.

URL maps are used with the following Google Cloud products:

There are two types of URL map resources available: global and regional. The type of resource that you use depends on the product's load balancing scheme.

Product Load-balancing scheme URL map resource type Supported destinations
Regional external HTTP(S) load balancer EXTERNAL_MANAGED Regional, external Backend services
External HTTP(S) load balancer EXTERNAL Global, external Backend services, backend buckets
Internal HTTP(S) load balancer INTERNAL_MANAGED Regional, internal Backend services
Traffic Director INTERNAL_SELF_MANAGED Global, internal Backend services

Not all URL map features are available for all products. URL maps used with Regional external HTTP(S) load balancers, internal HTTP(S) load balancers and Traffic Director also support several advanced traffic management features. For more information about these differences, see Advanced traffic management.

How URL maps work

When a request arrives at the load balancer, the load balancer routes the request to a particular backend service or a backend bucket based on the rules defined in the URL map.

A backend service represents a collection of backends, which are instances of an application or microservice. A backend bucket is a Cloud Storage bucket, which is commonly used to host static content, such as images.

For external HTTP(S) load balancers, internal HTTP(S) load balancers, and Traffic Director, possible destinations are the following:

Additionally, an external HTTP(S) load balancer supports the following:

For example, assume that you have the following setup:

  • One IP address:
    • All requests to your organization go to the same IP address and the same load balancer.
    • Traffic is directed to different backend services based on the request URL.
  • Two domains:
    • example.net hosts training videos.
    • example.org hosts your organization website.
  • Four sets of servers:
    • One hosts your organization website (backend service: org-site).
    • One hosts the overall training video website (backend service: video-site).
    • One hosts high definition (HD) training videos (backend service: video-hd).
    • One hosts standard definition (SD) training videos (backend service: video-sd).

You want the following to happen:

  • Requests to example.org (or any domain other than example.net) to go to the org-site backend service.
  • Requests to example.net that do not match more specific paths to go to the video-site backend service.
  • Requests to example.net/video/hd/* to go to the video-hd backend service.
  • Requests to example.net/video/sd/* to go to the video-sd backend service.

A --path-rule for /video/* matches URIs such as /video/test1, /video/test2, and so on. However, this path rule doesn't match the path /video.

If the load balancer receives a request with /../ in the URL, the load balancer responds with a 302 redirection. For example, when the request is sent for http://example.net/video/../abc, the load balancer converts this request to http://example.net/abc and processes it according to the URL map configuration. This 302 redirection isn't logged in Cloud Logging.

The URL map lets you set up this type of host and path-based routing.

Example backend service setup (click to enlarge)
Example backend service setup (click to enlarge)

Naming

Each URL map has a name. When you create an HTTP(S)-based load balancer by using the Google Cloud Console, the URL map is assigned a name. This name is the same as the name of the load balancer. If you use the gcloud command-line tool or the API, you can define a custom name for the URL map.

URL map components

A URL map is a set of Google Cloud configuration resources that direct requests for URLs to backend services or backend buckets. The URL map does so by using the hostname and path portions for each URL it processes:

  • A hostname is the domain name portion of a URL; for example, the hostname portion of the URL http://example.net/video/hd is example.net.
  • A path is the portion of a URL following the hostname and optional port number; for example, the path portion of the URL http://example.net/video/hd is /video/hd.
Load balancer configuration with basic URL map (click to enlarge).
Load balancer configuration with basic URL map (click to enlarge)

This diagram shows the structure of the load balancing configuration objects in relation to each other.

You control which backend services or backend buckets receive incoming requests by using the following URL map configuration parameters:

  • Default backend service or default backend bucket. When you create a URL map, you must specify either a default backend service or a default backend bucket, but not both. This default represents the backend service or backend bucket to which Google Cloud directs requests for URLs with any hostname, unless there is an applicable host rule.

  • Host rule (hostRules). A host rule directs requests sent to one or more associated hostnames to a single path matcher (pathMatchers). The host name portion of a URL is exactly matched against the set of the host rule's configured hostnames. In a URL map host and path rule, if you omit the host, the rule matches any requested host. To direct requests for http://example.net/video/hd to a path matcher, you need a single host rule that at least includes the hostname example.net. That same host rule could also handle requests for other hostnames, but it would direct them to the same path matcher.

    If you need to direct requests to different path matchers, you must use different host rules. Two host rules in a URL map can't include the same host name.

    It is possible to match all hostnames by specifying the wildcard character * in the host rule. For example, for the URLs http://example.org, http://example.net/video/hd, and http://example.com/audio, all three host names example.org, example.net, and example.com can be matched by specifying * in the host rule. It is also possible to match a partial host name by wildcard character *. For example, a host rule *.example.net is matched against both hostnames foo.example.net and bar.example.net.

    • Port number. You can also use the Host rule parameter to specify a port number. For example, to direct example.net requests for port 8080, set the host rule to example.net:8080.

  • Path matcher (pathMatchers). A path matcher is the configuration parameter referenced by a host rule. It defines the relationship between the path portion of a URL and the backend service or backend bucket that should serve the request. A path matcher consists of two elements:

    • Path matcher default backend service or path matcher default backend bucket. For each path matcher, you must at least specify a default backend service or default backend bucket, but not both. This default represents the backend service or backend bucket to which Google Cloud directs requests for URLs whose hostnames match a host rule associated with the path matcher, and whose URL paths do not match any path rule in the path matcher.

    • Path rules. For each path matcher, you can specify one or more path rules, which are key-value pairs mapping a URL path to a single backend service or backend bucket. The next section contains more information about how path rules work.

Order of operations

For a given hostname and path in a requested URL, Google Cloud uses the following procedure to direct the request to the correct backend service or backend bucket, as configured in your URL map:

  • If the URL map does not contain a host rule for the URL's hostname, Google Cloud directs requests to the URL map's default backend service or default backend bucket, depending on which one you defined.

  • If the URL map contains a host rule that includes the URL's hostname, the path matcher referenced by that host rule is consulted:

    • If the path matcher contains a path rule that exactly matches the URL's path, Google Cloud directs requests to the backend service or backend bucket for that path rule.

    • If the path matcher does not contain a path rule that exactly matches the URL's path, but does contain a path rule ending in /* whose prefix matches the longest section of the URL's path, then Google Cloud directs requests to the backend service or backend bucket for that path rule. For example, for the URL map containing two path matcher rules /video/hd/movie1 and /video/hd/*, if the URL contains the exact path /video/hd/movie1, it is matched against that path rule.

    • If neither of the previous conditions is true, Google Cloud directs requests to the path matcher's default backend service or default backend bucket, depending on which one you defined.

Path matcher constraints

Hostnames, path matchers, and path rules have constraints.

Wildcards, regular expressions, and dynamic URLs in path rules

  • A path rule can only include a wildcard character (*) after a forward slash character (/). For example, /videos/* and /videos/hd/* are valid for path rules, but /videos* and /videos/hd* are not.

  • Path rules do not use regular expression or substring matching. For example, path rules for either /videos/hd or /videos/hd/* do not apply to a URL with the path /video/hd-abcd. However, a path rule for /video/* does apply to that path.

  • Path matchers (and URL maps in general) do not offer features that function like Apache LocationMatch directives. If you have an application that generates dynamic URL paths that have a common prefix, such as /videos/hd-abcd and /videos/hd-pqrs, and you need to send requests made to those paths to different backend services, you might not be able to do that with a URL map. For simple cases containing only a few possible dynamic URLs, you might be able to create a path matcher with a limited set of path rules. For more complex cases, you need to do path-based regular expression matching on your backends.

Hostname and host rule relationship

  • A hostname can only reference a single host rule.

  • A single host rule can process multiple hostnames.

The relationship between hostnames and host rules (click to enlarge).
The relationship between hostnames and host rules (click to enlarge)

Host rule and path matcher relationship

  • Multiple host rules can reference a single path matcher.

  • A host rule can only reference a single path matcher.

The following diagram illustrates these points.

The relationship between host rules and path matchers (click to enlarge).
The relationship between host rules and path matchers (click to enlarge)

URL and backend relationship

  • Each unique URL is directed to only one backend service or backend bucket. Consequently:

    • Google Cloud uses the hostname portion of a URL to select a single host rule and its referenced path matcher.

    • When you use path rules in a path matcher, you cannot create more than one path rule for the same path. For example, requests for /videos/hd cannot be directed to more than one backend service or backend bucket. Backend services can have backend instance groups or backend network endpoint groups (NEGs) in different zones and regions, and you can create backend buckets that use Multi-Regional Storage classes.

    To direct traffic for a unique URL to multiple services, you can use route rules instead of path rules. If you configure the path matcher with route rules for header or parameter matches, a unique URL can be directed to more than one backend service or bucket, based on the contents of headers or query parameters on the URL.

    Similarly for regional HTTP(S) load balancers and Traffic Director, weighted backend services on route actions can direct the same URL to multiple backend services or buckets, depending on the weights set on the weighted backend service.

URL maps and protocols

You can use the same URL map, host rules, and path matchers to process both HTTP and HTTPS requests submitted by clients, as long as both a target HTTP proxy and a target HTTPS proxy reference the URL map.

You can use a URL map to configure redirection, as shown in the following guides:

Simplest URL map

The simplest URL map only has a default backend service or a default backend bucket. It contains no host rules and no path matchers. Either the default backend service or the default backend bucket (whichever one you defined) handles all requested URLs.

If you define a default backend service, Google Cloud directs requests to its backend instance groups or backend NEGs according to the backend service's configuration.

URL map with no rules except default (click to enlarge)
URL map with no rules except default (click to enlarge)

Example URL map workflow with an external HTTP(S) load balancer

The following example illustrates the order of operations for a URL map. This example configures the URL map for an external HTTP(S) load balancer. For conceptual simplicity, it only uses backend services; however, you can substitute backend buckets instead. To learn how to create the external HTTP(S) load balancer's other components, see Creating an external HTTP(S) load balancer.

For an example of how to create an internal HTTP(S) load balancer's URL map and other components, see Preparing for an Internal HTTP(S) Load Balancing setup.

Every backend service discussed in the following example has a scheme of external and uses the HTTP, HTTPS, or HTTP/2 protocol.

  1. Create a URL map for the load balancer and specify a default backend service. This example creates a URL map named video-org-url-map that references an existing backend service named org-site.

    gcloud compute url-maps create video-org-url-map \
    --default-service=org-site

  2. Create a path matcher named video-matcher with the following characteristics:

    • The default backend service is video-site, an existing backend service.
    • Add path rules that direct requests for the exact URL path /video/hd or the URL path prefix /video/hd/* to an existing backend service named video-hd.
    • Add path rules that direct requests for the exact URL path /video/sd or the URL path prefix /video/sd/* to an existing backend service named video-sd.
    gcloud compute url-maps add-path-matcher video-org-url-map \
    --path-matcher-name=video-matcher \
    --default-service=video-site \
    --path-rules=/video/hd=video-hd,/video/hd/*=video-hd,/video/sd=video-sd,/video/sd/*=video-sd

  3. Create a host rule for the example.net hostname that references the video-matcher path matcher.

    gcloud compute url-maps add-host-rule video-org-url-map \
    --hosts=example.net \
    --path-matcher-name=video-matcher

The video-org-url-map URL map should look like this:

gcloud compute url-maps describe video-org-url-map

creationTimestamp: '2021-03-05T13:34:15.833-08:00'
defaultService: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/backendServices/org-site
fingerprint: mfyJIT7Zurs=
hostRules:
- hosts:
  - '*'
  pathMatcher: video-matcher
- hosts:
  - example.net
  pathMatcher: video-matcher
id: '8886405179645041976'
kind: compute#urlMap
name: video-org-url-map
pathMatchers:
- defaultService: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/backendServices/video-site
  name: video-matcher
  pathRules:
  - paths:
    - /video/hd
    - /video/hd/*
    service: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/backendServices/video-hd
  - paths:
    - /video/sd
    - /video/sd/*
    service: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/backendServices/video-sd
selfLink: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/urlMaps/video-org-url-map

The video-org-url-map URL map directs requested URLs to backends in the following way.

URL map with a path rule, path matchers, and a host rule (click to enlarge)
URL map with a path rule, path matchers, and a host rule (click to enlarge)

The following table explains the request processing shown in the preceding diagram.

Hostname URL paths Selected backend service Reason for selection
Hostname:
example.org and all other hostnames different from
example.net		 all paths org-site The hostname is not in any host rule of the URL map, so the request is directed to the URL map's default backend service.
Hostname:
example.net		 /video
/video/examples		 video-site The request goes to the default backend service because there is no path rule for /video/ or /video/*. The host rule for example.net references a path matcher, but that path matcher does not have any path rules that would apply to these paths.
Hostname:
example.net		 /video/hd
/video/hd/movie1
/video/hd/movies/movie2
Other URLs that begin with /video/hd/*		 video-hd A host rule for example.net references a path matcher whose path rules direct requests for URL paths that either exactly match /video/hd or that begin with /video/hd/* to the video-hd backend service.
Hostname:
example.net		 /video/sd
/video/sd/show1
/video/sd/shows/show2
Other URLs that begin with /video/sd/*		 video-sd A host rule for example.net references a path matcher whose path rules direct requests for URL paths that either exactly match /video/sd or that begin with /video/sd/* to the video-sd backend service.

URL redirects

A URL redirect redirects your domain's visitors from one URL to another.

A default URL redirect is not conditioned on matching any particular pattern in the incoming request. For example, you might want to use a default URL redirect to redirect any hostname to a hostname of your choice.

There are several ways to create a URL redirect, as outlined in the following table.

Method Configuration
URL map's default URL redirect Top-level defaultUrlRedirect
A path matcher's default URL redirect pathMatchers[].defaultUrlRedirect[]
A path matcher's path rule's URL redirect pathMatchers[].pathRules[].urlRedirect
A path matcher's route rule's URL redirect pathMatchers[].routeRules[].urlRedirect

Inside of a defaultUrlRedirect or urlRedirect, pathRedirect always works as follows:

  • The entire request path is replaced with the path you specify.

Inside of a defaultUrlRedirect or urlRedirect, how theprefixRedirect works depends on how you use it:

  • If you use a defaultUrlRedirect, prefixRedirect is effectively a prefix prepend because the matched path is always /.
  • If you use a urlRedirect within a path matcher's route rule or path rule, prefixRedirect is a prefix replacement based on how the requested path was matched as defined in the path rule or route rule.

Redirect examples

The following table provides some examples of redirect configurations. The right-hand column shows the API configuration for a default URL redirect.

You want Accomplished using a default URL redirect
HTTP-to-HTTPS redirect

Redirect
http://host.name/path
to
https://host.name/path 
            kind: compute#urlMap
            name: web-map-http
            defaultUrlRedirect:
              httpsRedirect: True
HTTP-to-HTTPS + Host redirect

Redirect
http://any-host-name/path
to
https://www.example.com/path 
            kind: compute#urlMap
            name: web-map-http
            defaultUrlRedirect:
              httpsRedirect: True
              hostRedirect: "www.example.com"
HTTP-to-HTTPS + Host redirect + Full path redirect

Redirect
http://any-host-name/path
to
https://www.example.com/newPath 
            kind: compute#urlMap
            name: web-map-http
            defaultUrlRedirect:
              httpsRedirect: True
              hostRedirect: "www.example.com"
              pathRedirect: "/newPath"
HTTP-to-HTTPS + Host redirect + Prefix redirect

Redirect
http://any-host-name/originalPath
to
https://www.example.com/newPrefix/originalPath 
            kind: compute#urlMap
            name: web-map-http
            defaultUrlRedirect:
              httpsRedirect: True
              hostRedirect: "www.example.com"
              prefixRedirect: "/newPrefix"

The following example annotates each API resource.

kind: compute#urlMap
name: web-map-http
defaultUrlRedirect:
   redirectResponseCode: MOVED_PERMANENTLY_DEFAULT
   httpsRedirect: True # True if you want https://, false if you want http://
   hostRedirect: "new-host-name.com" # Omit to keep the requested host
   pathRedirect: "/new-path" # Omit to keep the requested path; mutually exclusive to prefixRedirect
   prefixRedirect: "/newPrefix" # Omit to keep the requested path; mutually exclusive to pathRedirect
   stripQuery: False # True to omit everything in the URL after ?
  },
  "defaultUrlRedirect": {
    "redirectResponseCode": enum,
  }

For complete end-to-end examples, see the following pages:

Advanced traffic management

Not all URL map features are available for all products. URL maps are used with regional external HTTP(S) load balancers, internal HTTP(S) load balancers and Traffic Director to support several advanced traffic management features, not all of which are supported on the external HTTP(S) load balancer.

Use the following table to find out which URL map features are available for each product. Each product has dedicated topics to explain how traffic management works and includes sample URL maps for each use case.

Product URL map features and traffic management guides
External HTTP(S) load balancer Load balancer features: Routing and traffic management

Traffic management overview for external HTTP(S) load balancer
Regional external HTTP(S) load balancer Load balancer features: Routing and traffic management

Traffic management overview for regional external HTTP(S) load balancer

Setting up traffic management for regional external HTTP(S) load balancer

Internal HTTP(S) load balancer Load balancer features: Routing and traffic management

Traffic management overview for internal HTTP(S) load balancer

Setting up traffic management for internal HTTP(S) load balancer

Traffic Director Traffic Director features: Routing and traffic management

Advanced traffic management overview

Configuring advanced traffic management

API and Cloud SDK reference

In addition to the Cloud Console, you can use the API and Cloud SDK to create URL maps.

API

For descriptions of the properties and methods available to you when working with URL maps through the REST API, see the following:

Product API documentation
External HTTP(S) Load Balancing urlMaps
Internal HTTP(S) Load Balancing regionUrlMaps
Traffic Director urlMaps

Cloud SDK

For the gcloud command-line tool in the Cloud SDK, see the following:

For advanced traffic management, use YAML files and import them with the gcloud compute url-maps import command.

What's next