API Management 10.4 | Using API Gateway | Aliases | Creating an Endpoint Alias
 
Creating an Endpoint Alias
You must have the API Gateway's manage aliases functional privilege assigned to perform this task.
An endpoint alias stores the endpoint value along with additional properties such as connection timeout, read timeout, whether to pass security headers or not, keystore alias, key alias, and so on.
* To create an endpoint alias
1. Expand the menu options icon , in the title bar, and select Aliases.
2. Click Create alias.
3. In the Basic information section, provide the following information:
Field
Description
Name
Name of the alias.
Type
Select Endpoint alias.
Description
Description of the alias.
4. Click Technical information and provide the following information:
Field
Description
Optimization technique
This is applicable only for a SOAP API.
Specify the optimization technique for the SOAP request received. Select any one of the following:
*None. This is the default value. API Gateway does not use any optimization method to parse the SOAP requests to the API.
*MTOM. Indicates that API Gateway expects to receive a request with a Message Transmission Optimization Mechanism (MTOM) attachment and forwards the attachment to the native service.
*SWA. Indicates that API Gateway expects to receive a SOAP with Attachment (SWA) request and forwards the attachment to the native service.
Pass WS-Security Headers
Passes the security header.
Endpoint URI
Specify the default URI or components of the URI such as service name.
Connection timeout
Specify the time interval (in seconds) after which a connection attempt times out.
The precedence of the Connection Timeout configuration is as follows:
a. If you specify a value for the Connection timeout field in routing endpoint alias, then the Connection timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
b. If you specify a value 0 for the Connection timeout field in routing endpoint alias, then API Gateway uses the value specified in the Connection timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
c. If you specify a value 0 or do not specify a value for the Connection timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then API Gateway uses the value specified in this pg.endpoint.connectionTimeout property.
d. If you do not specify any value for pg.endpoint.connectionTimeout, then API Gateway uses the default value of 30 seconds.
Read timeout
Specify the time interval (in seconds) after which a socket read attempt times out.
The precedence of the Read Timeout configuration is as follows:
a. If you specify a value for the Read timeout field in routing endpoint alias, then the Read timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
b. If you specify a value 0 for the Read timeout field in routing endpoint alias, then API Gateway uses the value specified in the Read Timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
c. If you specify a value 0 or do not specify a value for the Read timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then API Gateway uses the value specified in this pg.endpoint.readTimeout property.
d. If you do not specify any value for pg.endpoint.readTimeout, then API Gateway uses the default value of 30 seconds.
Keystore alias
Specify the keystore alias of the truststore that contains all the trusted public certificates.
Key alias
Specifies the key alias that is used by the SSL connection.
5. Click Save.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release