List the database instances of a client
List the Instance properties of all the database instances associated to the client.
Query Parameters
- clientName string required
Name of the Cloud Account
- applicationId integer required
Possible values: [
104
,125
]Id of the App Type. 104-MySQL/MariaDB, 125-PostgreSQL
Responses
- 200
- 404
OK
- application/json
- Schema
- Example (from schema)
- App Id-104
- App Id-125
Schema
instanceProperties object[]
clientAppType integerisDeleted booleanapplicationSize integerexcludeFromSLA booleanscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType boolean
{
"instanceProperties": [
{
"clientAppType": 0,
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"scIdxEnabled": 0,
"isSnapEnabled": true,
"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
}
]
}
}
]
}
{
"instanceProperties": [
{
"clientAppType": 1,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 1080033280,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "ash-azure-shinchan",
"instanceName": "mariadb/mariadb-eu[eastus]",
"displayName": "ash-azure-shinchan",
"instanceId": 589,
"instanceGUID": "2210DC12-FAEC-4317-85A0-5615C62ADA7D",
"clientId": 183,
"appName": "MariaDB",
"applicationId": 104
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mySqlInstance": {
"sslCa": "",
"EnableNoLocking": false,
"BinaryDirectory": "",
"archiveLogIndexFile": "",
"LogDataDirectory": "",
"sslEnabled": true,
"EnableAutoDiscovery": true,
"isStandBy": false,
"lastLogNumber": "0",
"ConfigFile": "",
"dataDirectory": "datadir:c:\\\\mysqldata;datadirUserPath:datadir:c:\\\\mysqldata;",
"sslCert": "",
"version": "10.3.23",
"useADAuthentication": false,
"port": "mariadb-eu.azure.com:3306",
"sslKey": "",
"logStoragePolicy": {
"storagePolicyName": "common_plan",
"storagePolicyId": 12
},
"proxySettings": {
"isUseSSL": false,
"isProxyEnabled": false,
"runBackupOnProxy": false,
"proxyInstance": {
"instanceId": 0
}
},
"NTUser": {
"userName": ""
},
"mebSettings": {
"mebBinPath": "",
"enableMEB": false
},
"SAUser": {
"userName": "mariatest@mariadb-eu"
},
"mysqlStorageDevice": {
"logBackupStoragePolicy": {
"storagePolicyName": "common_plan",
"storagePolicyId": 12
},
"commandLineStoragePolicy": {
"storagePolicyName": "common_plan",
"storagePolicyId": 12
}
},
"unixUser": {
"userName": ""
},
"clusterSettings": {},
"xtraBackupSettings": {
"xtraBackupBinPath": "",
"enableXtraBackup": false
}
},
"planEntity": {
"planType": 2,
"planName": "common_plan",
"planSubtype": 33554437,
"planId": 2
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"clientAppType": 1,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 1080033280,
"excludeFromSLA": false,
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "ash-azure-shinchan",
"instanceName": "mysql8flexibleserver[eastus]",
"displayName": "ash-azure-shinchan",
"instanceId": 365,
"instanceGUID": "FCE8CD6A-E8D4-47A0-9CAD-81E14BBB207D",
"clientId": 183,
"appName": "MySQL",
"applicationId": 104
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mySqlInstance": {
"sslCa": "",
"EnableNoLocking": false,
"BinaryDirectory": "",
"archiveLogIndexFile": "",
"LogDataDirectory": "",
"sslEnabled": false,
"EnableAutoDiscovery": true,
"isStandBy": false,
"lastLogNumber": "0",
"ConfigFile": "",
"dataDirectory": "datadir:\\\\app\\\\work\\\\data;datadirUserPath:datadir:\\\\app\\\\work\\\\data;",
"sslCert": "",
"version": "8.0.32",
"useADAuthentication": false,
"port": "mysql8flexibleserver.azure.com:3306",
"sslKey": "",
"logStoragePolicy": {
"storagePolicyName": "sudheer_plan",
"storagePolicyId": 19
},
"proxySettings": {
"isUseSSL": false,
"isProxyEnabled": false,
"runBackupOnProxy": false,
"proxyInstance": {
"instanceId": 0
}
},
"NTUser": {
"userName": ""
},
"mebSettings": {
"mebBinPath": "",
"enableMEB": false
},
"SAUser": {
"userName": "root"
},
"mysqlStorageDevice": {
"logBackupStoragePolicy": {
"storagePolicyName": "sudheer_plan",
"storagePolicyId": 19
},
"commandLineStoragePolicy": {
"storagePolicyName": "sudheer_plan",
"storagePolicyId": 19
}
},
"unixUser": {
"userName": ""
},
"clusterSettings": {},
"xtraBackupSettings": {
"xtraBackupBinPath": "",
"enableXtraBackup": false
}
},
"planEntity": {
"planType": 2,
"planName": "sudheer_plan",
"planSubtype": 33554437,
"planId": 5
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"clientAppType": 1,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 169869312,
"excludeFromSLA": false,
"version": "11.18",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "ash-azure-shinchan",
"instanceName": "pg11servereastus[eastus]",
"displayName": "ash-azure-shinchan",
"instanceId": 650,
"instanceGUID": "D0EB84FE-BC4F-4B2B-B939-1A43F20D6E90",
"clientId": 183,
"appName": "PostgreSQL",
"applicationId": 125
},
"postGreSQLInstance": {
"BinaryDirectory": "D:\\\\Program Files\\\\Commvault\\\\ContentStore\\\\CVCloudAddOns\\\\PostgreSQL\\\\11\\\\bin",
"ArchiveDelete": false,
"useGCPApi": false,
"ArchiveLogDirectory": "",
"isStandBy": false,
"lastLogNumber": "",
"MaintainenceDB": "postgres",
"useClientCloudCredentials": false,
"planSchedAssocType": 0,
"LibDirectory": "D:\\\\Program Files\\\\Commvault\\\\ContentStore\\\\CVCloudAddOns\\\\PostgreSQL\\\\11\\\\lib",
"port": "pg11servereastus.azure.com:5432",
"sslOpt": {
"sslCa": "",
"sslEnabled": false,
"sslKey": "",
"sslCert": ""
},
"logStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"UNCUser": {
"userName": ""
},
"standbyOptions": {
"useMasterForLogBkp": false,
"isStandbyEnabled": false,
"useMasterForDataBkp": false,
"standbyInstance": {
"instanceName": "DefaultInstanceName",
"instanceId": 1
}
},
"SAUser": {
"userName": "postgres@pg11servereastus"
},
"osUser": {
"userName": ""
},
"gcpOptions": {
"stagingBucketURI": "",
"dumpFileType": 0,
"useCompression": false
},
"clusterSettings": {}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "a_default_winter11",
"planSubtype": 33554437,
"planId": 22
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
},
{
"clientAppType": 1,
"jobStartTime": -1,
"isDeleted": false,
"applicationSize": 169869312,
"excludeFromSLA": false,
"version": "14.9",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "ash-azure-shinchan",
"instanceName": "pg14flexible[eastus]",
"displayName": "ash-azure-shinchan",
"instanceId": 463,
"instanceGUID": "6BF02E99-1B00-4AF1-94E9-D0E9420A9F31",
"clientId": 183,
"appName": "PostgreSQL",
"applicationId": 125
},
"postGreSQLInstance": {
"BinaryDirectory": "D:\\\\Program Files\\\\Commvault\\\\ContentStore\\\\CVCloudAddOns\\\\PostgreSQL\\\\14\\\\bin",
"ArchiveDelete": false,
"useGCPApi": false,
"ArchiveLogDirectory": "",
"isStandBy": false,
"lastLogNumber": "",
"MaintainenceDB": "postgres",
"useClientCloudCredentials": false,
"planSchedAssocType": 0,
"LibDirectory": "D:\\\\Program Files\\\\Commvault\\\\ContentStore\\\\CVCloudAddOns\\\\PostgreSQL\\\\14\\\\lib",
"port": "pg14flexible.azure.com:5432",
"sslOpt": {
"sslCa": "",
"sslEnabled": false,
"sslKey": "",
"sslCert": ""
},
"logStoragePolicy": {
"storagePolicyName": "CV_DEFAULT",
"storagePolicyId": 1
},
"UNCUser": {
"userName": ""
},
"standbyOptions": {
"useMasterForLogBkp": false,
"isStandbyEnabled": false,
"useMasterForDataBkp": false,
"standbyInstance": {
"instanceName": "DefaultInstanceName",
"instanceId": 1
}
},
"SAUser": {
"userName": "postgres"
},
"osUser": {
"userName": ""
},
"gcpOptions": {
"stagingBucketURI": "",
"dumpFileType": 0,
"useCompression": false
},
"clusterSettings": {}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"planEntity": {
"planType": 2,
"planName": "sudheer_plan",
"planSubtype": 33554437,
"planId": 5
},
"cloudDBInstance": {
"overRideAccessNode": false,
"accessNodes": {}
}
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No client is specified",
"errorCode": 4
}
Loading...