Skip to main content

Modify Subclient

This operation is used to update subclient contents of an RDS instance.

Path Parameters
  • subclientID integer required

    id of the subclient

Request Body
  • subClientProperties object
  • cloudAppsSubClientProp object
  • instanceType string

    Possible values: [AMAZON_RDS]

  • cloudDbContent object
  • children object[]
  • path string required

    Region name in AWS format.

  • negation boolean required
  • displayName string required

    Dispaly name of cloud account.

  • name string required

    Region or instance name.

  • allOrAnyChildren boolean
  • type integer
  • value string required

    Region followed by instance name.

  • association object
  • entity object[]
  • clientName string required

    Cloud account name.

  • instanceName string required

    RDS instance name.

  • displayName string required

    Dispaly name of cloud account.

  • _type_ string

    Possible values: [SUBCLIENT_ENTITY]

  • appName string

    Possible values: [Cloud Apps]

  • backupsetName string

    Possible values: [defaultBackupSet]

  • subclientName string required

    Name of the subclient to be updated.

Responses

OK


Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
POST /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
subclientID — path required
Content-Type
Body

{
"subClientProperties": {
"cloudAppsSubClientProp": {
"instanceType": "AMAZON_RDS"
},
"cloudDbContent": {
"children": [
{
"path": "string",
"negation": true,
"displayName": "string",
"name": "string",
"allOrAnyChildren": true,
"type": 0,
"value": "string"
}
]
}
},
"association": {
"entity": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"_type_": "SUBCLIENT_ENTITY",
"appName": "Cloud Apps",
"backupsetName": "defaultBackupSet",
"subclientName": "string"
}
]
}
}
Accept
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"cloudAppsSubClientProp": {
"instanceType": "AMAZON_RDS"
},
"cloudDbContent": {
"children": [
{
"path": "string",
"negation": true,
"displayName": "string",
"name": "string",
"allOrAnyChildren": true,
"type": 0,
"value": "string"
}
]
}
},
"association": {
"entity": [
{
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"_type_": "SUBCLIENT_ENTITY",
"appName": "Cloud Apps",
"backupsetName": "defaultBackupSet",
"subclientName": "string"
}
]
}
}'