Skip to main content

Modify MySQL Instance​

Select

SaaS
Customer Managed

This operation is used to modify MySQL instance property

Path Parameters
  • instanceId integer required

    InstanceId of the MySQL Instance

Request Body
  • instanceProperties object
  • instance object
  • instanceId integer required
  • instanceName string
  • applicationId integer required

    Default value: 104

    104 for MySQL

  • clientId integer required
  • clientName string
  • commCellId integer

    Default value: 2

  • planEntity object
  • planId integer required

    PlanId of the plan to be associated to MySQL Instance

  • mySqlInstance object
  • SAUser object
  • userName string required

    MySQL database username

  • unixUser object
  • userName string

    Operating system username

  • port string required

    Port number for Windows MySQL Instance, Socket File or Endpoint for Unix MySQL Instance

  • useADAuthentication boolean
  • BinaryDirectory string required

    MySQL Server binary directory

  • LogDataDirectory string required

    MySQL server log directory

  • ConfigFile string required

    MySQL server configuration file

  • sslEnabled boolean

    MySQL SSL Enable status

  • sslCa string
  • sslCert string
  • sslKey string
  • EnableNoLocking boolean

    No Locking status for MySQL Enterprise backup

  • xtraBackupSettings object

    Xtrabackup properties

  • xtraBackupBinPath string

    Xtrabackup binary path

  • enableXtraBackup boolean
  • mebSettings object

    MySQL Enterprise Backup settings

  • mebBinPath string

    MySQL Enterprise backup binary path

  • enableMEB boolean
  • proxySettings object

    MySQL Proxy backup settings

  • isUseSSL boolean
  • isProxyEnabled boolean
  • runBackupOnProxy boolean
  • proxyInstance object
  • displayName string

    Proxy MySQL Instance display name

  • clientId integer

    Proxy Client Id

  • instanceName string

    Proxy MySQL Instance name

  • applicationId integer

    Default value: 104

    104 for MySQL

  • clientName string

    Proxy Client Name

  • instanceId integer

    Proxy Instance id

  • selected boolean

    Run transaction log backups on source checkbox selection

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
instanceId — path required
Body
{

  "instanceProperties": {

    "instance": {

      "instanceId": 0,

      "instanceName": "string",

      "applicationId": 104,

      "clientId": 0,

      "clientName": "string",

      "commCellId": 2

    },

    "planEntity": {

      "planId": 0

    },

    "mySqlInstance": {

      "SAUser": {

        "userName": "string"

      },

      "unixUser": {

        "userName": "string"

      },

      "port": "string",

      "useADAuthentication": true,

      "BinaryDirectory": "string",

      "LogDataDirectory": "string",

      "ConfigFile": "string",

      "sslEnabled": true,

      "sslCa": "string",

      "sslCert": "string",

      "sslKey": "string",

      "EnableNoLocking": true,

      "xtraBackupSettings": {

        "xtraBackupBinPath": "string",

        "enableXtraBackup": true

      },

      "mebSettings": {

        "mebBinPath": "string",

        "enableMEB": true

      },

      "proxySettings": {

        "isUseSSL": true,

        "isProxyEnabled": true,

        "runBackupOnProxy": true,

        "proxyInstance": {

          "displayName": "string",

          "clientId": 0,

          "instanceName": "string",

          "applicationId": 104,

          "clientName": "string",

          "instanceId": 0,

          "selected": true

        }

      }

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "instanceName": "string",
      "applicationId": 104,
      "clientId": 0,
      "clientName": "string",
      "commCellId": 2
    },
    "planEntity": {
      "planId": 0
    },
    "mySqlInstance": {
      "SAUser": {
        "userName": "string"
      },
      "unixUser": {
        "userName": "string"
      },
      "port": "string",
      "useADAuthentication": true,
      "BinaryDirectory": "string",
      "LogDataDirectory": "string",
      "ConfigFile": "string",
      "sslEnabled": true,
      "sslCa": "string",
      "sslCert": "string",
      "sslKey": "string",
      "EnableNoLocking": true,
      "xtraBackupSettings": {
        "xtraBackupBinPath": "string",
        "enableXtraBackup": true
      },
      "mebSettings": {
        "mebBinPath": "string",
        "enableMEB": true
      },
      "proxySettings": {
        "isUseSSL": true,
        "isProxyEnabled": true,
        "runBackupOnProxy": true,
        "proxyInstance": {
          "displayName": "string",
          "clientId": 0,
          "instanceName": "string",
          "applicationId": 104,
          "clientName": "string",
          "instanceId": 0,
          "selected": true
        }
      }
    }
  }
}'