Get MySQL Instances associated to a client
Get the properties of MySQL Instances associated to the client
Query Parameters
- clientName string required
Name of the client
- appName string required
Default value:
MySQL
Application name is MySQL
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- My S Q L Instance Property
Schema
instanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerautoDiscovered booleaninstance object
Instance general properties
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleanmySqlInstance object
Instance MySQL specific properties
sslCa stringEnableNoLocking booleanBinaryDirectory stringarchiveLogIndexFile stringLogDataDirectory stringsslEnabled booleanEnableAutoDiscovery booleanisStandBy booleanlastLogNumber stringConfigFile stringdataDirectory stringsslCert stringversion stringuseADAuthentication booleanport stringsslKey stringlogStoragePolicy object
storagePolicyName stringstoragePolicyId integerproxySettings object
isUseSSL booleanisProxyEnabled booleanrunBackupOnProxy booleanproxyInstance object
instanceId integerNTUser object
Windows NT user
userName stringmebSettings object
MySQL Enterprise Backup properties in Instance
mebBinPath stringenableMEB booleanSAUser object
MySQL Database user
userName stringmysqlStorageDevice object
logBackupStoragePolicy object
storagePolicyName stringstoragePolicyId integercommandLineStoragePolicy object
storagePolicyName stringstoragePolicyId integerunixUser object
Unix user
userName stringclusterSettings objectxtraBackupSettings object
Xtrabackup properties
xtraBackupBinPath stringenableXtraBackup booleanplanEntity object
planType integerplanName stringplanSubtype integerplanId integercloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"autoDiscovered": true,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "string",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"mySqlInstance": {
"sslCa": "string",
"EnableNoLocking": true,
"BinaryDirectory": "string",
"archiveLogIndexFile": "string",
"LogDataDirectory": "string",
"sslEnabled": true,
"EnableAutoDiscovery": true,
"isStandBy": true,
"lastLogNumber": "string",
"ConfigFile": "string",
"dataDirectory": "string",
"sslCert": "string",
"version": "string",
"useADAuthentication": true,
"port": "string",
"sslKey": "string",
"logStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"proxySettings": {
"isUseSSL": true,
"isProxyEnabled": true,
"runBackupOnProxy": true,
"proxyInstance": {
"instanceId": 0
}
},
"NTUser": {
"userName": "string"
},
"mebSettings": {
"mebBinPath": "string",
"enableMEB": true
},
"SAUser": {
"userName": "string"
},
"mysqlStorageDevice": {
"logBackupStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"commandLineStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
}
},
"unixUser": {
"userName": "string"
},
"clusterSettings": {},
"xtraBackupSettings": {
"xtraBackupBinPath": "string",
"enableXtraBackup": true
}
},
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"autoDiscovered": false,
"instance": {
"clientName": "mysql",
"instanceName": "mysql_3306",
"displayName": "mysql",
"instanceId": 21,
"instanceGUID": "23350A10-CE0F-4881-AC3B-E43CD50BAEDB",
"clientId": 5,
"appName": "MySQL",
"applicationId": 104,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mySqlInstance": {
"sslCa": "",
"EnableNoLocking": false,
"BinaryDirectory": "/usr/bin",
"archiveLogIndexFile": "",
"LogDataDirectory": "/var/lib/mysql",
"sslEnabled": false,
"EnableAutoDiscovery": true,
"isStandBy": false,
"lastLogNumber": "0",
"ConfigFile": "/etc/my.cnf",
"dataDirectory": "datadir:/var/lib/mysql/;usergroup:mysql#mysql;",
"sslCert": "",
"version": "5.7.22",
"useADAuthentication": false,
"port": "/var/lib/mysql/mysql.sock",
"sslKey": "",
"logStoragePolicy": {
"storagePolicyName": "database_plan",
"storagePolicyId": 4
},
"proxySettings": {
"isUseSSL": false,
"isProxyEnabled": false,
"runBackupOnProxy": false,
"proxyInstance": {
"instanceId": 0
}
},
"NTUser": {
"userName": ""
},
"mebSettings": {
"mebBinPath": "",
"enableMEB": false
},
"SAUser": {
"userName": "root"
},
"mysqlStorageDevice": {
"logBackupStoragePolicy": {
"storagePolicyName": "database_plan",
"storagePolicyId": 4
},
"commandLineStoragePolicy": {
"storagePolicyName": "database_plan",
"storagePolicyId": 4
}
},
"unixUser": {
"userName": ""
},
"clusterSettings": {},
"xtraBackupSettings": {
"xtraBackupBinPath": "/usr/bin",
"enableXtraBackup": true
}
},
"planEntity": {
"planType": 2,
"planName": "database_plan",
"planSubtype": 33554437,
"planId": 1
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Loading...