Fetch MSSQL Instance Properties
This operation will fetch the properties of the MSSQL instance
Path Parameters
- instanceId string required
Id of the instance
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
instanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanversion stringscIdxEnabled integerautoDiscovered booleaninstance object
clientName stringinstanceName stringdisplayName stringinstanceId integerinstanceGUID stringclientId integerappName stringapplicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleanmssqlInstance object
serverType stringawsSqlInfo object
sqlInstanceCredentials object
agProperties object
SQLAvailabilityReplicasList object
availabilityGroup object
proxyClient object
azureInfo object
azureCredentials object
azureSqlInstanceCredentials object
proxies object
cloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"version": "string",
"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
}
]
},
"mssqlInstance": {
"serverType": "string",
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
},
"proxies": {}
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"version": "string",
"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
}
]
},
"mssqlInstance": {
"serverType": "string",
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
},
"proxies": {}
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}
Loading...