Modify MySQL Instance
This operation is used to modify MySQL instance property
Path Parameters
- instanceId integer required
InstanceId of the MySQL Instance
- application/json
Request Body
instanceProperties object
instance object
instanceId integer requiredinstanceName stringapplicationId integer requiredDefault value:
104
104 for MySQL
clientId integer requiredclientName stringcommCellId integerDefault value:
2
planEntity object
planId integer requiredPlanId of the plan to be associated to MySQL Instance
mySqlInstance object
SAUser object
userName string requiredMySQL database username
unixUser object
userName stringOperating system username
port string requiredPort number for Windows MySQL Instance, Socket File or Endpoint for Unix MySQL Instance
useADAuthentication booleanBinaryDirectory string requiredMySQL Server binary directory
LogDataDirectory string requiredMySQL server log directory
ConfigFile string requiredMySQL server configuration file
sslEnabled booleanMySQL SSL Enable status
sslCa stringsslCert stringsslKey stringEnableNoLocking booleanNo Locking status for MySQL Enterprise backup
xtraBackupSettings object
Xtrabackup properties
xtraBackupBinPath stringXtrabackup binary path
enableXtraBackup booleanmebSettings object
MySQL Enterprise Backup settings
mebBinPath stringMySQL Enterprise backup binary path
enableMEB booleanproxySettings object
MySQL Proxy backup settings
isUseSSL booleanisProxyEnabled booleanrunBackupOnProxy booleanproxyInstance object
displayName stringProxy MySQL Instance display name
clientId integerProxy Client Id
instanceName stringProxy MySQL Instance name
applicationId integerDefault value:
104
104 for MySQL
clientName stringProxy Client Name
instanceId integerProxy Instance id
selected booleanRun transaction log backups on source checkbox selection
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
warningCode integererrorCode integerwarningMessage stringentity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "string",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"warningCode": 0,
"errorCode": 0,
"warningMessage": "",
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "",
"instanceId": 0,
"_type_": 0
}
}
]
}
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 2
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "User does not have permission on the entity.",
"errorCode": 587205847
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to update properties because jobs are in progress for the Instance",
"errorCode": 1
}