Get MySQL instance properties

This operation fetches the MySQL Instance property

Path Parameters

instanceId integer required
InstanceId of the MySQL Instance

Responses

application/json

Schema
Example (from schema)
My S Q L Instance Property

Schema

instanceProperties object[]
isDeleted boolean
applicationSize integer
excludeFromSLA boolean
scIdxEnabled integer
autoDiscovered boolean
instance object
Instance general properties
clientName string
instanceName string
displayName string
instanceId integer
instanceGUID string
clientId integer
appName string
applicationId integer
entityInfo object
companyId integer
companyName string
multiCommcellId integer
instanceActivityControl object
Instance activity control options
activityControlOptions object[]
activityType integer
enableAfterADelay boolean
enableActivityType boolean
mySqlInstance object
Instance mysql properties
sslCa string
EnableNoLocking boolean
BinaryDirectory string
archiveLogIndexFile string
LogDataDirectory string
sslEnabled boolean
EnableAutoDiscovery boolean
isStandBy boolean
lastLogNumber string
ConfigFile string
dataDirectory string
sslCert string
version string
useADAuthentication boolean
port string
sslKey string
logStoragePolicy object
storagePolicyName string
storagePolicyId integer
proxySettings object
isUseSSL boolean
isProxyEnabled boolean
runBackupOnProxy boolean
proxyInstance object
instanceId integer
NTUser object
userName string
mebSettings object
mebBinPath string
enableMEB boolean
SAUser object
userName string
mysqlStorageDevice object
logBackupStoragePolicy object
storagePolicyName string
storagePolicyId integer
commandLineStoragePolicy object
storagePolicyName string
storagePolicyId integer
unixUser object
userName string
clusterSettings object
xtraBackupSettings object
xtraBackupBinPath string
enableXtraBackup boolean
planEntity object
planType integer
planName string
planSubtype integer
planId integer
cloudDBInstance object
overRideAccessNode boolean
accessNodes 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": 20,
        "instanceGUID": "07FBAC7C-8607-41E3-8687-D649FDB24AE1",
        "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": "9",
        "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": "/usr/bin",
          "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": {}
      }
    }
  ]
}

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": "string",
  "errorCode": 0
}

GET /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

instanceId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get MySQL instance properties​

Authorization

Request

Get MySQL instance properties