Add MySQL Instance
This operation adds a MySQL Instance in Client
- application/json
Request Body
instanceProperties object required
instance object
instanceName string requiredName of the MySQL Instance
applicationId integer requiredDefault value:
104
104 for MySQL
clientId integer requiredClinetID in which MySQL Instance is to be added
clientName stringmySqlInstance object required
BinaryDirectory string requiredBinary directory of MySQL Server
LogDataDirectory string requiredLog Directory Of MySQL Server
ConfigFile string requiredConfiguration file of MySQL Server
port string requiredPort number for Windows, Socket File/ Endpoint for
EnableAutoDiscovery booleanSAUser object
userName string requiredMySQL database username
password stringBase64 encrypted database user password
NTUser object
userName stringWindows NT username
password stringBase64 encode Windows NT user password
proxySettings object
isProxyEnabled booleanproxyInstance object
Proxy Instance name
instanceId integerisUseSSL booleanrunBackupOnProxy booleanxtraBackupSettings object
Percona Xtrabackup setting
enableXtraBackup booleanmebSettings object
MySQL Enterprise Backup setting
enableMEB booleansslEnabled booleanplanEntity object required
planId integer
Responses
- 200
- 400
- 401
- 409
- 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": 5,
"instanceName": "mysqlwin_3306",
"instanceId": 20,
"_type_": 0
}
}
}
Bad Request
Response Headers
- 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
}
Conflict
- application/json
- Schema
- Example (from schema)
- Example 2
Schema
- errorMessage string
- errorCode integer
entity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"errorMessage": "string",
"errorCode": 0,
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
{
"errorMessage": "An instance by this name already exists.",
"errorCode": 3,
"entity": {
"subclientId": 0,
"clientId": 5,
"instanceName": "mysqlwin_3306",
"instanceId": -1,
"_type_": 0
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Invalid My S Q L Enterprise Backup binary directory
Schema
- errorMessage string
- errorCode integer
entity object
subclientId integerclientId integerinstanceName stringinstanceId integer_type_ integer
{
"errorMessage": "string",
"errorCode": 0,
"entity": {
"subclientId": 0,
"clientId": 0,
"instanceName": "string",
"instanceId": 0,
"_type_": 0
}
}
{
"errorMessage": "Invalid MEB bin directory.",
"errorCode": 4444,
"entity": {
"subclientId": 0,
"clientId": 200,
"instanceName": "mysql_3306",
"instanceId": 430,
"_type_": 0
}
}
Loading...