Add Oracle Instance

Select

SaaS

Customer Managed

This operation adds an Oracle Instance.

application/json

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

  For authentication methods other than OS default authentication ('/' as username) and wallet (which uses domainName property in this object), please create a credential and specify id in dbConnectCredInfo. Usage of inline passwords is deprecated

  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

  Deprecated, please use catalogConnectCredInfo instead

  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

  osUserCredInfo object

  Applicable only for Windows clients. Used for impersonation

  credentialId integer

  Credential ID of type 'Windows Account'

  dbConnectCredInfo object

  Used to connect to the Oracle DB. Create and assign a credential of type 'Oracle' when you want to use a different auth type than OS authentication ('/' as username in sqlConnect)

  credentialId integer

  Credential ID of type 'Oracle'

  catalogConnectCredInfo object

  Used to connect to the recovery catalog. Create a credential of type 'Oracle Recovery Catalog' and use it here

  credentialId integer

  Credential ID of type 'Oracle Recovery Catalog'

  planEntity object

  planId integer

  PlanID of plan to be associated to the client

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

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

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "instanceId": 0,
      "clientId": 0,
      "instanceName": "string"
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "instanceId": 10,
      "clientId": 11,
      "instanceName": "aurora/aurorapg13[us-east-1]"
    }
  }
}

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

application/xml

• Schema
• Example (from schema)

---

Schema

• object

<root/>

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Loading...