Fetch Subclients associated to an Oracle instance

Select

SaaS

Customer Managed

This operation fetches all subclients associated to an Oracle instance

Query Parameters

clientId integer required
Client Id of the client
applicationId integer required
Default value: 22
instanceId string required
Instance Id of Oracle instance

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

filterQueryCount integer
subClientProperties object[]
useLocalContent boolean
useLocalArchivalRules boolean
planEntity object
cassandraProps object
splunkProps object
proxyClient object
dcPlanEntity object
subClientEntity object
Subclient details
clientName string
instanceName string
displayName string
backupsetId integer
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
dfsSubclientProp object
region object
analyticsSubclientProp object

{
  "filterQueryCount": 0,
  "subClientProperties": [
    {
      "useLocalContent": true,
      "useLocalArchivalRules": true,
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "region": {},
      "analyticsSubclientProp": {}
    }
  ]
}

{
  "filterQueryCount": 4,
  "subClientProperties": [
    {
      "useLocalContent": false,
      "useLocalArchivalRules": false,
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "oraserv1",
        "instanceName": "ora1",
        "displayName": "oraserv1",
        "backupsetId": 44,
        "commCellName": "CS1",
        "instanceId": 499,
        "csGUID": "DCADAE9FA-7EADS8-4ASFSFE25-AEASDE2-D498FFA7445B",
        "subclientGUID": "EB41-4184-8AE5-592B709",
        "subclientId": 8851,
        "clientId": 1129,
        "appName": "Oracle",
        "backupsetName": "default",
        "applicationId": 22,
        "subclientName": "default",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "region": {},
      "analyticsSubclientProp": {}
    },
    {
      "useLocalContent": false,
      "useLocalArchivalRules": false,
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "oraserv1",
        "instanceName": "ora1",
        "displayName": "oraserv1",
        "backupsetId": 44,
        "_type_": 7,
        "commCellName": "CS1",
        "instanceId": 495,
        "csGUID": "DD-4C25-AEE2-D498FFA7445B",
        "subclientGUID": "BC44E6-B3D1-B5B72077676B",
        "subclientId": 8852,
        "clientId": 1129,
        "appName": "Oracle",
        "backupsetName": "default",
        "applicationId": 22,
        "subclientName": "(command line)",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "region": {},
      "analyticsSubclientProp": {}
    },
    {
      "useLocalContent": false,
      "useLocalArchivalRules": false,
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "oraserv1",
        "instanceName": "ora1",
        "displayName": "oraserv1",
        "backupsetId": 44,
        "_type_": 7,
        "commCellName": "CS1",
        "instanceId": 4226,
        "csGUID": "DDCEE9FA-7E8C-4C25-AEE2-D498FFA7445B",
        "subclientGUID": "D491BE9C-DA9B-42BC-BC75-DFF4D2EC56E1",
        "subclientId": 8853,
        "clientId": 1129,
        "appName": "Oracle",
        "backupsetName": "default",
        "applicationId": 22,
        "subclientName": "ArchiveLog",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "region": {},
      "analyticsSubclientProp": {}
    },
    {
      "useLocalContent": false,
      "useLocalArchivalRules": false,
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "oraserv1",
        "instanceName": "ora1",
        "displayName": "oraserv1",
        "backupsetId": 44,
        "_type_": 7,
        "commCellName": "CS1",
        "instanceId": 550,
        "csGUID": "DDCEE9FA-7E8C-25-AEE2-FHJFNJDN77",
        "subclientGUID": "AUSDHUSD-SJDIDJISDJ-9905-6CBB8CD79D4C",
        "subclientId": 8925,
        "clientId": 1129,
        "appName": "Oracle",
        "backupsetName": "default",
        "applicationId": 22,
        "subclientName": "new",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "region": {},
      "analyticsSubclientProp": {}
    }
  ]
}

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 client/instance is specified",
  "errorCode": 4
}

GET /subclient

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

clientId — query required

applicationId — query required

instanceId — query required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Fetch Subclients associated to an Oracle instance​

Authorization

Request

Fetch Subclients associated to an Oracle instance