Integration Server 10.15 | Integration Server Administrator's Guide | Setting Up HTTP URL Aliases | Creating an HTTP URL Alias
 
Creating an HTTP URL Alias
 
Specifying the URL Path
Using Port Mappings with a URL Alias
Using a URL Alias for the “Empty Path”
When you create a URL alias, you create an association between an alias and a resource on Integration Server. Keep the following information in mind when creating a URL alias:
*You can create a URL alias for a request that comes through an HTTP or HTTPS port only.
*An alias name must be unique across Integration Server.
*Do not use a directive as the URL alias. Integration Server uses directives in a URL to route the request. For a list of directives, see Controlling the Use of Directives.
*You can associate a single URL alias with multiple destinations by specifying port mappings. A port mapping correlates the alias with a different URL alias based on the port on which the request was received. For more information about creating port mappings for a URL alias, see Using Port Mappings with a URL Alias.
*You can create a URL alias for the empty path (/) for a hostname:port combination, such as localhost:5555. By creating an empty path alias, you can specify a default destinations for any incoming port. For more information about the empty path alias, see Using a URL Alias for the “Empty Path”.
*If you want to use URL alias with a REST resource you must enable partial matching of URL aliases. For more information, see Enabling Partial Matching of URL Aliases.
*If you enabled or intend to enable partial matching of URL aliases, do not define an alias that begins with another alias. For more information, see Enabling Partial Matching of URL Aliases.
*You can create an HTTP URL alias for a service using Designer as well as Integration Server. However, if you want to use the same URL alias for more than one service or a service and other resources, you must create the URL alias using Integration Server Administrator. For instructions on creating an HTTP URL alias from Designer, see webMethods Service Development Help.
*As of 10.3, Microservices Runtime or Integration Server equipped with a Microservices Runtime license creates two predefined URL alias named “health” and “metrics” for use with the health and metrics endpoints that provide monitoring capabilities. Software AG recommends that you avoid creating URL aliases with these names. Additionally, Software AG does not recommend editing the predefined URL aliases. As of 10.15, Microservices Runtime, Integration Server, or Integration Server equipped with a Microservices Runtime license creates the following predefined URL aliases in addition to /health:
*health/readiness: Checks the server health. Invokes the same service as /health. The endpoint is http://host:port/health/readiness.
*/health/liveness: Checks whether the server is reachable. The endpoint is http://host:port/health/liveness.
Note:
If you migrate to Microservices Runtime version 10.3 or higher from an earlier version and you already have a URL alias named “health” and/or “metrics”, Microservices Runtime does not create the “health” and/or “metrics” URL alias. Any invocation of the health or metrics endpoints does not result in execution of health indicators or metrics gathering, respectively. If you want to use the health gauge and/or metrics gathering, you need to rename your existing URL alias named “health” or “metrics”. Upon restart, Microservices Runtime will create a new health and/or metrics URL alias that corresponds to the health endpoint and/or metrics functionality. The scenario is applicable to "/health/readiness" and "/health/liveness" when migrating to Integration Server 10.15.
*To create an HTTP URL alias
1. Open Integration Server Administrator if it is not already open.
2. Go to Settings > URL aliases.
3. Click Create URL Alias.
4. Under URL Alias Properties, provide the following information:
For this parameter...
Specify...
Alias
A name for the alias.
The alias name cannot include a space, nor can it include the following characters:
# % ? ’ “ < \
The alias name cannot begin with the string "http://"
There is no length restriction for the alias.
Do not use a directive as the alias. For a list of directives, see Controlling the Use of Directives.
Note:
Do not specify an alias if you intend to use this URL alias for the empty path.
Use as empty path alias
Select this check box if you want to use this alias for the empty path.
When you select the Use as empty path alias check box, Integration Server changes the alias to <EMPTY>.
Default URL Path
The path to the resource on Integration Server. For details on how to specify a URL path for the different types of destinations, see Specifying the URL Path.
You must specify a Default URL Path field if you do not define any port mappings for the URL alias.
If the URL alias includes port mappings, the Default URL Path field is optional. However, it might be useful to supply a Default URL Path value so that a request received on a port for which there is not a port mapping will “fall through” to the default URL path. If a URL alias specifies a port mapping but does not specify a Default URL Path value, Integration Server uses the alias as the URL path.
The URL path cannot include a space or the following characters: # % ? ’ “ < \
Package
Name of the package with which you want to associate this alias.
5. If you want to define a different destination for the URL alias based on the incoming port, create a port mapping. For information, see Using Port Mappings with a URL Alias. do the following:
6. Click Save Changes.