Jump to

• Request
• Response
• Examples

Create a Service Instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances

Creates a new service instance.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the service account

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Body ()

JSON payload for this REST endpoint

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• cloudStorageContainer: string
  The storage container describes the location in the cloud where Elastic Search will be backed up to.
• cloudStorageContainerAutoGenerate(optional): string
  Create Cloud Storage Container
• cloudStoragePassword: string
  Cloud Storage Server Password
• cloudStorageUser: string
  Cloud Storage Server User Name
• components: object components
  components
• featureset(optional): string

  The feature set to be provisioned in Oracle Integration Classic. Valid values:

  • ics: provisions Integrations only
  • ics_pcs: provisions Integrations and Process
  • ia: provisions Integration Analytics

• serviceName: string
  This is the unique name used to identify the service in the tenant domain
• vmPublicKeyText: string
  Click Edit to enter an existing public key's value or upload a new public key.

{
    "type":"object",
    "required":[
        "cloudStorageContainer",
        "cloudStoragePassword",
        "serviceName",
        "cloudStorageUser",
        "vmPublicKeyText",
        "components"
    ],
    "properties":{
        "cloudStorageContainer":{
            "type":"string",
            "description":"The storage container describes the location in the cloud where Elastic Search will be backed up to."
        },
        "cloudStoragePassword":{
            "type":"string",
            "description":"Cloud Storage Server Password"
        },
        "cloudStorageUser":{
            "type":"string",
            "description":"Cloud Storage Server User Name"
        },
        "cloudStorageContainerAutoGenerate":{
            "type":"string",
            "description":"Create Cloud Storage Container"
        },
        "serviceName":{
            "type":"string",
            "description":"This is the unique name used to identify the service in the tenant domain"
        },
        "featureset":{
            "type":"string",
            "description":"<p>The feature set to be provisioned in Oracle Integration Classic. Valid values:</p><p><ul><li><code>ics</code>: provisions Integrations only</li><li><code>ics_pcs</code>: provisions Integrations and Process</li><li><code>ia</code>: provisions Integration Analytics</li></ul></p>"
        },
        "vmPublicKeyText":{
            "type":"string",
            "description":"Click Edit to enter an existing public key's value or upload a new public key."
        },
        "components":{
            "type":"object",
            "description":"components",
            "required":[
                "WLS"
            ],
            "properties":{
                "WLS":{
                    "type":"object",
                    "required":[
                        "dbServiceName",
                        "dbaName",
                        "dbaPassword",
                        "managedServerCount"
                    ],
                    "properties":{
                        "dbServiceName":{
                            "type":"string",
                            "description":"Name of the Oracle Database Cloud - Databse as a Service instance to be used with the API Platform Cloud Service instance. The specified database service instance must be running."
                        },
                        "dbaName":{
                            "type":"string",
                            "description":"Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user <code>SYS</code> or a user that has been granted the <code>SYSDBA</code> privilege."
                        },
                        "dbaPassword":{
                            "type":"string",
                            "description":"Password for the Oracle Database Cloud - Database as a Service instance administrator."
                        },
                        "managedServerCount":{
                            "type":"string",
                            "description":"Number of managed servers."
                        }
                    }
                }
            }
        }
    },
    "title":"Request Body"
}

Nested Schema : components

Type: object

components

Show Source

• WLS: object WLS

{
    "type":"object",
    "description":"components",
    "required":[
        "WLS"
    ],
    "properties":{
        "WLS":{
            "type":"object",
            "required":[
                "dbServiceName",
                "dbaName",
                "dbaPassword",
                "managedServerCount"
            ],
            "properties":{
                "dbServiceName":{
                    "type":"string",
                    "description":"Name of the Oracle Database Cloud - Databse as a Service instance to be used with the API Platform Cloud Service instance. The specified database service instance must be running."
                },
                "dbaName":{
                    "type":"string",
                    "description":"Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user <code>SYS</code> or a user that has been granted the <code>SYSDBA</code> privilege."
                },
                "dbaPassword":{
                    "type":"string",
                    "description":"Password for the Oracle Database Cloud - Database as a Service instance administrator."
                },
                "managedServerCount":{
                    "type":"string",
                    "description":"Number of managed servers."
                }
            }
        }
    }
}

Nested Schema : WLS

Type: object

Show Source

• dbaName: string
  Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user SYS or a user that has been granted the SYSDBA privilege.
• dbaPassword: string
  Password for the Oracle Database Cloud - Database as a Service instance administrator.
• dbServiceName: string
  Name of the Oracle Database Cloud - Databse as a Service instance to be used with the API Platform Cloud Service instance. The specified database service instance must be running.
• managedServerCount: string
  Number of managed servers.

{
    "type":"object",
    "required":[
        "dbServiceName",
        "dbaName",
        "dbaPassword",
        "managedServerCount"
    ],
    "properties":{
        "dbServiceName":{
            "type":"string",
            "description":"Name of the Oracle Database Cloud - Databse as a Service instance to be used with the API Platform Cloud Service instance. The specified database service instance must be running."
        },
        "dbaName":{
            "type":"string",
            "description":"Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user <code>SYS</code> or a user that has been granted the <code>SYSDBA</code> privilege."
        },
        "dbaPassword":{
            "type":"string",
            "description":"Password for the Oracle Database Cloud - Database as a Service instance administrator."
        },
        "managedServerCount":{
            "type":"string",
            "description":"Number of managed servers."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId(optional): string
  Job ID of the operation.
• message(optional): string
  System message that describes the operation. For example: Submitted job to create service [{serviceName}] in domain [{identityDomainId}].

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to create an Oracle Integration Classic Instance by submitting a POST request on the REST resource using cURL.

Note:

The command in this example uses the URL structure https://example.com/resource-path, where example.com is the Oracle Cloud server to contact for your identity domain.

cURL Command

curl -i -X POST -u jstein:Password --data @testpayload.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain"  http://example.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances

Example of Request Header

The following shows an example of the response header.

headers: Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json
Authorization: <Basic Auth credentials>
X-ID-TENANT-NAME: <identity domain>

Example of Request Body

The following shows an example of the request body in JSON format.

{
"serviceParameters":
	{
	 "vmPublicKeyText":"ssh-rsa key imported   -openssh-key", 
   "featureSet": "ics_pcs",
   "serviceName":"host21",
   "cloudStorageContainer":"Storage/JaaSBackup",
   "cloudStorageUser":"Storageadmin",
   "cloudStoragePassword":"password", 
   "confirmation": true,
   "meteringFrequency":"HOURLY" 
  }, 
  "componentParameters": 
  { 
 	"WLS":
  {
     "dbServiceName":"OICDBaaS",
     "dbaName":"db_name",
     "dbaPassword":"password",
     "managedServerCount":"2"
   }
 }
}

Back to Top