REST Operations Hub Service
The REST Operations Hub Service is an application service in the Informatica domain that exposes Informatica product functionality to external clients through REST APIs.
The REST Operations Hub Service receives requests from REST service clients and passes them to the respective Informatica Service. The Informatica Service processes the requests and sends a response to the REST Operations Hub. The REST Operations Hub sends the response back to the REST service client.
The REST Operations Hub Service is not highly available.
To protect data that is transmitted between a REST Operations Hub Service and REST client, secure the connection between the REST Operations Hub Service and REST client. To do this, enable the Transport Layer Security for the REST Operations Hub Service.
The REST Operations Hub supports REST APIs for retrieving mapping execution statistics for the Data Engineering Integration product.
REST Operations Hub Service Properties
To configure the REST Operations Hub Service properties, select the service in the Domain Navigator and click the Properties view. You can change the properties while the service is running, but you must recycle the service for the changed properties to take effect.
General Properties
In the general properties, configure the primary and back-up nodes for the REST Operations Hub Service.
The following table describes the general properties for the service:
Property | Description |
|---|
Name | Name of the service. You cannot change the name of the REST Operations Hub Service. |
Description | Description of the service. The description cannot exceed 765 characters. |
Node | Node on which the service runs. |
REST Operations Hub Service Process Properties
To configure the REST Operations Hub Service process properties, select the service in the Domain Navigator and click the Processes view. You can change the properties while the service is running, but you must restart the service process for the changed properties to take effect.
Security Properties
When you set the HTTP protocol type for the REST Operations Hub Service to HTTPS or both, you enable the Transport Layer Security (TLS) protocol for the service. Depending on the HTTP protocol type of the service, you define the HTTP port, the HTTPS port, or both ports for the service process.
The following table describes the REST Operations Hub Service security properties:
Property | Description |
|---|
HTTP Port | Unique HTTP port number for the REST Operations Hub Service process when the service uses the HTTP protocol. Default is 6555. |
HTTPS Port | Port number that the REST Operations Hub Service runs on when you enable the Transport Layer Security (TLS) protocol. Use a different port number than the HTTP port number. |
Enable Transport Layer Security | Select to enable a secure connection between the REST Operations Hub Service and REST client. |
Keystore File | Directory where the keystore file that contains the digital certificates is stored. |
Keystore Password | Plain-text password for the keystore file. If this property is not set, the REST Operations Hub Service uses the default password. |
SSL Protocol | A blank field enables the highest version of TLS available. The version of TLS enabled depends on the value. If you enter a value, earlier versions of TLS might be enabled. The behavior is based on the Java version for your environment. For more information, see the documentation for your Java version. |
Reverse Proxy Server for Load Balancing
REST Operations Hub handles API requests, load balances them, and then routes them to the target Data Integration Service.
The REST Operations Hub manages incoming service requests and act as a reverse proxy server to route to the target Data Integration Service. Additionally, REST Operations Hub also load balance the requests across nodes in a grid.
The first REST API request is routed to Node 1 on DIS 1. The second REST API request is then routed to Node 2 on DIS1 to load balance by using the round robin algorithm.
REST API Documentation Properties
When you set the HTTP protocol type for the Data Integration Service to HTTPS or both, you enable the Transport Layer Security (TLS) protocol for the service. Depending on the HTTP protocol type of the service, you define the HTTP URL, the HTTPS URL, or both for the service process.
The following table describes the REST API Documentation properties:
Property | Description |
|---|
HTTP URL | HTTP URL for the Data Integration Service process when the service uses the HTTP protocol. |
HTTPS URL | HTTPS URL for the Data Integration Service process when the service uses the HTTPS protocol. |
Reverse Proxy Server Properties
Lists the reverse proxy server properties.
The following table describes the Reverse Proxy Server properties:
Property | Description |
|---|
URL to Check Reverse Proxy Server Status | URL that shows the status of reverse proxy server. Available options: |
Enable Reverse Proxy Server | Indicates whether you want to enable the reverse proxy server. |
Protocol Type | Lists the available protocol types for URL. Available options: - - HTTP
- - HTTPS
- - Both: Includes both HTTP and HTTPS.
|
HTTP Port | HTTP port on which reverse proxy server listens. |
HTTPS Port | HTTPS port on which reverse proxy server listens. |
SSL Certificate for the Reverse Proxy Server | Indicates an absolute path to a PEM certificate file to enable the HTTPS mode of the reverse proxy server. |
SSL Certificate Key for the Reverse Proxy Server | Indicates an absolute path to a PEM secret key file to enable the HTTPS mode of the reverse proxy server. |
Password File for the Reverse Proxy Server | Indicates an absolute path to a file containing password for the secret key file to enable the HTTPS mode of the reverse proxy server. |
Verify Incoming Clients | Indicates whether to verify the client that connects to the reverse proxy server. |
SSL Certificate for the Incoming Client | Indicates an absolute path to a PEM file containing trusted CA certificates to authenticate the client. |
SSL Certificate for the Proxied HTTPS Server | Indicates an absolute path to a PEM file to authenticate the reverse proxy server to a proxied HTTPS server. |
SSL Certificate Key for the HTTPS Server | Indicates an absolute path to a PEM secret key file to authenticate the reverse proxy server to a proxied HTTPS server. |
Password File for the Proxied Server | Indicates an absolute path to a file containing password for the secret key file to authenticate the reverse proxy server to a proxied server. |
