Creating an Integration Service cluster


The create API uses the POST method to create an Integration Service cluster. You must provide authentication credentials by using the login API before creating the cluster. For information about the authentication process, see Authentication-for-the-Infrastructure-Management-REST-API.

URL to access the create API

The generic format of a URL for the create API is as follows:

https://<TSPShostname>:<port>/tsws/10.0/api/unifiedadmin/
IntegrationServiceCluster/create

Example

https://tsps105:443/tsws/10.0/api/unifiedadmin/
IntegrationServiceCluster/create

Input parameters in the JSON format to create a Integration Service cluster

You can provide the following parameters in the JSON format along with the URL.

When you provide input parameters for any API request, you must specify the content-type parameter in the header of the API request as follows:

content-type application/json

The sample input parameters in the JSON format are as follows:

{
 "integrationServiceCluster": {
   "bppmserver": {
     "name":"comp001",
     "id": "1"
   },
   "integrationServices": [
     {
       "host":"IS01",
       "port":3183
     },
     {
       "host":"IS2",
       "port":3183
     }
    ],
   "name": "Clluster01",
   "description": "This is sample Cluster 01"
 }
}

Attributes

Description

bppmserver

Details of the Infrastructure Management server on which you plan to configure the Integration Service cluster. You can either provide the name of the server or the identifier for the Infrastructure Management server. 

This parameter is mandatory.

name

Name of the Infrastructure Management server

id

Identifier of the Infrastructure Management server

integrationServices

List of Integration Services that are part of the cluster. This parameter is mandatory.

host

Name of the Integration Service. This parameter is mandatory.

port

Port number through which communication is established. This parameter is mandatory.

name

Name of the Integration Service cluster that you create. This parameter is mandatory.

description

Brief description about the Integration Service cluster

Response information for the create API

A sample JSON response is as follows:

{
 "responseTimeStamp": "2016-05-18T23:03:21",
 "statusCode": "200",
 "statusMsg": "OK",
 "response": [
   {
     "resourceId": "c7714477-863c-49a6-8aa2-fc2443788c30",
     "resourceName": "Clluster01",
     "resourceURI": null,
     "statusCode": "200",
     "statusMsg": "OK"
   }
  ]
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*