Skip to main content

Add Oracle Instance

Select

SaaS
Customer Managed

This operation adds an Oracle Instance.

Request Body
  • instanceProperties object
  • instance object
  • instanceName string

    Name of the oracle instance

  • applicationId integer required

    Default value: 22

    22 for Oracle

  • appName string

    Default value: Oracle

  • clientId integer required

    ClientId of client on which instance is present

  • clientName string
  • commCellId integer

    Default value: 2

  • oracleInstance object
  • oracleHome string required

    Oracle data

  • oracleWalletAuthentication boolean

    Set to true if oracle wallet is configured

  • sqlConnect object
  • userName string

    Default value: /

    Oracle database username

  • password string

    Base64 encrypted database user password

  • domainName string

    Oracle SID/ DB TNS entry

  • confirmPassword string
  • useCatalogConnect boolean

    Set to true if user has recovery catalog configured on instance

  • catalogConnect object

    Applicable only if useCatalogConnect is enabled

  • userName string

    Recovery catalog user

  • password string

    Base64 encoded Recovery catalog user password

  • domainName string

    Recovery Catalog DB TNS Entry

  • confirmPassword string
  • blockSize integer

    Default value: 1048576

  • crossCheckTimeout integer

    Default value: 600

  • planEntity object
  • planId integer

    PlanID of plan to be associated to the client

Responses

OK


Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • instanceId integer
  • clientId integer
  • instanceName string
POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body

{
"instanceProperties": {
"instance": {
"instanceName": "string",
"applicationId": 22,
"appName": "Oracle",
"clientId": 0,
"clientName": "string",
"commCellId": 2
},
"oracleInstance": {
"oracleHome": "string",
"oracleWalletAuthentication": true,
"sqlConnect": {
"userName": "/",
"password": "string",
"domainName": "string",
"confirmPassword": "string"
},
"useCatalogConnect": true,
"catalogConnect": {
"userName": "string",
"password": "string",
"domainName": "string",
"confirmPassword": "string"
},
"blockSize": 1048576,
"crossCheckTimeout": 600
},
"planEntity": {
"planId": 0
}
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"instanceProperties": {
"instance": {
"instanceName": "string",
"applicationId": 22,
"appName": "Oracle",
"clientId": 0,
"clientName": "string",
"commCellId": 2
},
"oracleInstance": {
"oracleHome": "string",
"oracleWalletAuthentication": true,
"sqlConnect": {
"userName": "/",
"password": "string",
"domainName": "string",
"confirmPassword": "string"
},
"useCatalogConnect": true,
"catalogConnect": {
"userName": "string",
"password": "string",
"domainName": "string",
"confirmPassword": "string"
},
"blockSize": 1048576,
"crossCheckTimeout": 600
},
"planEntity": {
"planId": 0
}
}
}'