Modify MySQL database group

This operation is used to modify database group property

Path Parameters

• subclientId string required

  ID of database group

application/json

Request Body

• subClientProperties object

  Database group properties

  mySqlSubclientProp object

  MySQL agent specific properties

  proxySettings object

  MySQL Proxy Settings

  isFailOverToProduction boolean

  Use source if standby is unavailable toggle operation

  isProxyEnabled boolean

  Enable Standby backup toggle operation

  fullInstanceXtraBackup boolean

  Full Instance Xtrabackup toggle operation

  isUseBlockLevelBackup integer

  Use Volume copy (Block Level backup) toggle operation

  numberOfBackupStreams integer

  Possible values: >= 1 and <= 100

  Number of data streams

  commonProperties object

  Database group common properties

  snapCopyInfo object

  Snapshot Management

  isSnapBackupEnabled boolean

  Enable snap backup toggle operation

  snapToTapeSelectedEngine object

  snapShotEngineId integer

  Snapshot engine id

  snapShotEngineName string

  Snapshot engine name

  prepostProcess object

  Pre-process and post-process commands

  runPostScan integer

  runPostBackup integer

  runAs integer

  postBackupCommand string

  Post backup command/file location

  preBackupCommand string

  Pre backup command/file location

  prepostUserName object

  Impersonate user information

  userName string

  User name

  password string

  Base64 encoded password

  planEntity object

  planName string

  Plan name to be modified

• association object

  entity object[]

  subclientId integer

  Database group ID

  displayName string

  Client display name

  commCellName string

  Commcell Name

  clientId integer

  client ID

  instanceName string

  MySQL Insatnce Name

  appName string

  Default value: MySQL

  Application Name

  applicationId integer

  Default value: 104

  clientName string

  Clinet Name

  backupsetId integer

  instanceId integer

  MySQL Instance ID

  subclientGUID string

  subclientName string

  csGUID string

  backupsetName string

  Default value: defaultDummyBackupSet

  Backupset Name

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

  flags object

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string"
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": ""
    }
  ]
}

application/xml

• Schema
• Example (from schema)

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  Response warning code

  errorCode integer

  Response error code

  warningMessage string

  Response warning message

<root>
  <processinginstructioninfo>
    <attributes>
      <name>string</name>
      <value>string</value>
    </attributes>
  </processinginstructioninfo>
  <response>
    <warningCode>0</warningCode>
    <errorCode>0</errorCode>
    <warningMessage>string</warningMessage>
  </response>
</root>

Bad Request

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid.

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Forbidden

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "User [Remote User] does not have required capability [Agent Management] for this subclient and this operation.",
  "errorCode": 5
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Could not update property changes. Backup running for subclient.",
  "errorCode": 1
}

Loading...