Skip to main content

Create MySQL Database Group

This operation creates a database group in a MySQL Instance

Request Body
  • subClientProperties object

    MySQL database group general properties

  • subClientEntity object
  • subclientName string required

    Database group name

  • instanceName string required

    MySQL Instance name where database groups to be created

  • appName string required

    Default value: MySQL

  • clientName string required

    client Name

  • entityInfo object

    Internal Fields

  • companyId integer
  • companyName string

    Default value: Commcell

    Company name

  • multiCommcellId integer
  • commonProperties object
  • content object[] required

    Names of the databases to be added to the MySQL Database group content

  • mySQLContent object required

    Database names to be added exclusive. Refer examples for more details.

  • databaseName string required

    Database name

  • contentOperationType string required

    Default value: OVERWRITE

  • mySqlSubclientProp object

    MySQL Database group properties

  • numberOfBackupStreams integer required

    Possible values: >= 1 and <= 100

    Default value: 2

    Number of streams for data backup

  • numberOfTransactionLogStreams integer

    Default value: 1

  • fullInstanceXtraBackup boolean

    Default value: false

    Set when Xtrabackup option enabled at MySQL Instance level

  • planEntity object required
  • planName string

    Plan Name

Responses

OK


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

    ID of created database group

  • _type_ integer
POST /subclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body

{
"subClientProperties": {
"subClientEntity": {
"subclientName": "string",
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"commonProperties": {},
"content": [
{
"mySQLContent": {
"databaseName": "string"
}
}
],
"contentOperationType": "OVERWRITE",
"mySqlSubclientProp": {
"numberOfBackupStreams": 2,
"numberOfTransactionLogStreams": 1,
"fullInstanceXtraBackup": false
},
"planEntity": {
"planName": "string"
}
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"subClientProperties": {
"subClientEntity": {
"subclientName": "string",
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"commonProperties": {},
"content": [
{
"mySQLContent": {
"databaseName": "string"
}
}
],
"contentOperationType": "OVERWRITE",
"mySqlSubclientProp": {
"numberOfBackupStreams": 2,
"numberOfTransactionLogStreams": 1,
"fullInstanceXtraBackup": false
},
"planEntity": {
"planName": "string"
}
}
}'