Skip to main content

Create RAC subclient​

Select

SaaS
Customer Managed

This operation used to create OracleRAC Subclient

Request Body
  • subClientProperties object
  • subClientEntity object
  • subclientId integer
  • subclientName string required

    Subclient Name.

  • backupsetId integer
  • instanceId integer
  • instanceName string

    Instance Name

  • instanceGUID string
  • applicationId integer
  • appName string
  • clientId integer
  • clientName string required

    Client Name

  • displayName string
  • commonProperties object
  • contentOperationType string
  • oracleSubclientProp object
  • selectiveOnlineFull boolean

    Set to true for selective online full subclients.

  • data boolean

    Set to true for data backups

  • backupMode string

    Possible values: [ONLINE_DB, ONLINE_SUBSET_DB, OFFLINE_DB]

  • lightsOutScript boolean

    This is set to true for offline backups

  • enableTableBrowse boolean

    Set this to true if you want table level metadata to be collected.

  • backupArchiveLog boolean

    Enable this option to backup oracle archivelogs

  • archiveDelete boolean

    Set this to true if you want backup up archivelogs to be deleted on the client

  • dataThresholdStreams integer
  • oracleDataBackupStreams object[]

    This object is relevant for Online_Subset_DB backups

  • streamInstanceName string

    Instance name of the RAC cluster

  • streamNumber integer

    number of streams for log backups

  • instanceId integer

    RAC instance id of RAC database

  • oracleLogBackupStreams object[]
  • streamInstanceName string

    Instance name of the RAC cluster

  • streamNumber integer

    number of streams for log backups

  • instanceId integer

    RAC instance id of RAC database

  • archiveDeleteAll boolean
  • planEntity object
  • planId integer
Responses

OK

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

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "subClientProperties": {

    "subClientEntity": {

      "subclientId": 0,

      "subclientName": "string",

      "backupsetId": 0,

      "instanceId": 0,

      "instanceName": "string",

      "instanceGUID": "string",

      "applicationId": 0,

      "appName": "string",

      "clientId": 0,

      "clientName": "string",

      "displayName": "string"

    },

    "commonProperties": {},

    "contentOperationType": "string",

    "oracleSubclientProp": {

      "selectiveOnlineFull": true,

      "data": true,

      "backupMode": "ONLINE_DB",

      "lightsOutScript": true,

      "enableTableBrowse": true,

      "backupArchiveLog": true,

      "archiveDelete": true,

      "dataThresholdStreams": 0,

      "oracleDataBackupStreams": [

        {

          "streamInstanceName": "string",

          "streamNumber": 0,

          "instanceId": 0

        }

      ],

      "oracleLogBackupStreams": [

        {

          "streamInstanceName": "string",

          "streamNumber": 0,

          "instanceId": 0

        }

      ],

      "archiveDeleteAll": true

    },

    "planEntity": {

      "planId": 0

    }

  }

}

curl -L -X POST 'https://localhost/webconsole/api/subClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "subclientId": 0,
      "subclientName": "string",
      "backupsetId": 0,
      "instanceId": 0,
      "instanceName": "string",
      "instanceGUID": "string",
      "applicationId": 0,
      "appName": "string",
      "clientId": 0,
      "clientName": "string",
      "displayName": "string"
    },
    "commonProperties": {},
    "contentOperationType": "string",
    "oracleSubclientProp": {
      "selectiveOnlineFull": true,
      "data": true,
      "backupMode": "ONLINE_DB",
      "lightsOutScript": true,
      "enableTableBrowse": true,
      "backupArchiveLog": true,
      "archiveDelete": true,
      "dataThresholdStreams": 0,
      "oracleDataBackupStreams": [
        {
          "streamInstanceName": "string",
          "streamNumber": 0,
          "instanceId": 0
        }
      ],
      "oracleLogBackupStreams": [
        {
          "streamInstanceName": "string",
          "streamNumber": 0,
          "instanceId": 0
        }
      ],
      "archiveDeleteAll": true
    },
    "planEntity": {
      "planId": 0
    }
  }
}'