Skip to main content

Add RAC instance​

Select

SaaS
Customer Managed

This operation adds an Oracle RAC Instance.

Request Body
  • instanceProperties object
  • instance object
  • instanceId integer
  • instanceName string

    Name of the RACinstance

  • applicationId integer required

    Appid 80 for OracleRAC

  • clientName string
  • commCellId integer
  • planEntity object
  • planId integer
  • oracleRACInstance object
  • useCatalogConnect boolean

    Set to true if user has recovery catalog configured on instance

  • connectString object
  • userName string

    Oraclerac database username

  • password string

    Base64 encrypted database user password

  • domainName string

    Oraclerac SID/ DB TNS entry

  • ctrlFileAutoBackupType string
  • blockSize integer
  • racDBInstance object[]
  • instancePhysicalClient object
  • clientId integer required

    Id of client on where Racinstance is present

  • clientName string
  • displayName string
  • hostName string
  • instanceOracleSID string
  • userAccount object
  • oracleHome string required

    Oraclerac home path

  • connectString object

    Set to true if user has recovery catalog configured on instance

  • userName string

    Recovery catalog username

  • instance string
  • serviceName string

    Recovery Catalog DB TNS Entry

  • password string

    Base64 encoded Recovery catalog user password

  • racDBOperationType string
Responses

OK

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

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
Body
{

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "instanceName": "string",

      "applicationId": 0,

      "clientName": "string",

      "commCellId": 0

    },

    "planEntity": {

      "planId": 0

    },

    "oracleRACInstance": {

      "useCatalogConnect": true,

      "connectString": {

        "userName": "string",

        "password": "string",

        "domainName": "string"

      },

      "ctrlFileAutoBackupType": "string",

      "blockSize": 0,

      "racDBInstance": [

        {

          "instancePhysicalClient": {

            "clientId": 0,

            "clientName": "string",

            "displayName": "string",

            "hostName": "string"

          },

          "instanceOracleSID": "string",

          "userAccount": {},

          "oracleHome": "string",

          "connectString": {

            "userName": "string",

            "instance": "string",

            "serviceName": "string",

            "password": "string"

          }

        }

      ],

      "racDBOperationType": "string"

    }

  }

}

curl -L -X POST 'https://localhost/webconsole/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 0,
      "clientName": "string",
      "commCellId": 0
    },
    "planEntity": {
      "planId": 0
    },
    "oracleRACInstance": {
      "useCatalogConnect": true,
      "connectString": {
        "userName": "string",
        "password": "string",
        "domainName": "string"
      },
      "ctrlFileAutoBackupType": "string",
      "blockSize": 0,
      "racDBInstance": [
        {
          "instancePhysicalClient": {
            "clientId": 0,
            "clientName": "string",
            "displayName": "string",
            "hostName": "string"
          },
          "instanceOracleSID": "string",
          "userAccount": {},
          "oracleHome": "string",
          "connectString": {
            "userName": "string",
            "instance": "string",
            "serviceName": "string",
            "password": "string"
          }
        }
      ],
      "racDBOperationType": "string"
    }
  }
}'