Skip to main content

Modify PostgreSQL database group​

This operation is used to modify database group property

Path Parameters
  • subclientId string required

    ID of database group

Request Body
  • subClientProperties object
  • commonProperties object
  • snapCopyInfo object
  • isSnapBackupEnabled boolean

    Flag to enable/Disable snap backup

  • snapToTapeSelectedEngine object
  • snapShotEngineId integer
  • snapShotEngineName string

    Snap Engine Name

  • snapToTapeProxyToUse object
  • clientId integer
  • clientName string

    Proxy client to use for backup copy job

  • useSeparateProxyForSnapToTape boolean
  • backupCopyInterface string
  • separateProxyForSnapToTape object
  • clientId integer
  • clientName string
  • subClientEntity object
  • clientName string

    Client Name

  • instanceName string

    Instance Name

  • displayName string
  • backupsetId integer

    Backupset ID

  • _type_ integer
  • commCellName string
  • instanceId integer

    Instance ID

  • csGUID string
  • subclientGUID string
  • subclientId integer

    Subclient ID

  • clientId integer

    Client ID

  • appName string

    Default value: PostgreSQL

    Application name

  • backupsetName string

    Backupset Name

  • applicationId integer

    Appliction ID

  • subclientName string

    Subclient Name

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • contentOperationType integer
  • content object[]
  • postgreSQLContent object
  • databaseName string

    Database name to add to the content

  • postgreSQLSubclientProp object
  • numberOfBackupStreams integer

    Number of streams to be used for backup and restores

  • collectObjectListDuringBackup boolean

    Flag to determine Object list creation during backup

  • planEntity object
  • planName string

    Plan name to be associated with DB group

  • planId integer
  • association object
  • entity object[]
  • clientName string

    Client Name

  • instanceName string

    Instance Name

  • displayName string
  • backupsetId integer
  • _type_ integer
  • commCellName string
  • instanceId integer
  • csGUID string
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string

    Application Name

  • backupsetName string

    Backupset Name

  • applicationId integer
  • subclientName string

    Subclient Name

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
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
Body
{

  "subClientProperties": {

    "commonProperties": {

      "snapCopyInfo": {

        "isSnapBackupEnabled": true,

        "snapToTapeSelectedEngine": {

          "snapShotEngineId": 0,

          "snapShotEngineName": "string"

        },

        "snapToTapeProxyToUse": {

          "clientId": 0,

          "clientName": "string"

        },

        "useSeparateProxyForSnapToTape": true,

        "backupCopyInterface": "string",

        "separateProxyForSnapToTape": {

          "clientId": 0,

          "clientName": "string"

        }

      },

      "subClientEntity": {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "_type_": 0,

        "commCellName": "string",

        "instanceId": 0,

        "csGUID": "string",

        "subclientGUID": "string",

        "subclientId": 0,

        "clientId": 0,

        "appName": "PostgreSQL",

        "backupsetName": "string",

        "applicationId": 0,

        "subclientName": "string",

        "entityInfo": {

          "companyId": 0,

          "companyName": "string",

          "multiCommcellId": 0

        }

      }

    },

    "contentOperationType": 0,

    "content": [

      {

        "postgreSQLContent": {

          "databaseName": "string"

        }

      }

    ],

    "postgreSQLSubclientProp": {

      "numberOfBackupStreams": 0,

      "collectObjectListDuringBackup": true

    },

    "planEntity": {

      "planName": "string",

      "planId": 0

    }

  },

  "association": {

    "entity": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "_type_": 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

        }

      }

    ]

  }

}
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": {
    "commonProperties": {
      "snapCopyInfo": {
        "isSnapBackupEnabled": true,
        "snapToTapeSelectedEngine": {
          "snapShotEngineId": 0,
          "snapShotEngineName": "string"
        },
        "snapToTapeProxyToUse": {
          "clientId": 0,
          "clientName": "string"
        },
        "useSeparateProxyForSnapToTape": true,
        "backupCopyInterface": "string",
        "separateProxyForSnapToTape": {
          "clientId": 0,
          "clientName": "string"
        }
      },
      "subClientEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "PostgreSQL",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    },
    "contentOperationType": 0,
    "content": [
      {
        "postgreSQLContent": {
          "databaseName": "string"
        }
      }
    ],
    "postgreSQLSubclientProp": {
      "numberOfBackupStreams": 0,
      "collectObjectListDuringBackup": true
    },
    "planEntity": {
      "planName": "string",
      "planId": 0
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 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
        }
      }
    ]
  }
}'