Modify Oracle Instance

Select

SaaS

Customer Managed

This operation is used to modify instance using instanceId

Path Parameters

• instanceId integer required

  InstanceId of instance to be modified

application/json

Request Body

• instanceProperties object

  instance object

  instanceId integer required

  InstanceId of the oracle instance to be modified

  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

  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

• 200
• 400
• 401
• 404

---

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

  Info of instance modified

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

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

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

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
}

Not found

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "No instance is specified",
  "errorCode": 4
}

Loading...