Skip to main content

Get MySQL Instances associated to a client​

Select

SaaS
Customer Managed

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

OK

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
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • mySqlInstance object

    Instance MySQL specific 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

    Windows NT user

  • userName string
  • mebSettings object

    MySQL Enterprise Backup properties in Instance

  • mebBinPath string
  • enableMEB boolean
  • SAUser object

    MySQL Database user

  • userName string
  • mysqlStorageDevice object
  • logBackupStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • commandLineStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • unixUser object

    Unix user

  • userName string
  • clusterSettings object
  • xtraBackupSettings object

    Xtrabackup properties

  • xtraBackupBinPath string
  • enableXtraBackup boolean
  • planEntity object
  • planType integer
  • planName string
  • planSubtype integer
  • planId integer
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
Loading...