Get PostgreSQL instance properties
This operation fetches the PostgreSQL Instance property
Path Parameters
- instanceId integer required
InstanceId of the PostgreSQL Instance
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Postgre S Q L Instance Property
Schema
instanceProperties object[]
isDeleted booleanapplicationSize integerexcludeFromSLA booleanversion stringscIdxEnabled integerisSnapEnabled booleanautoDiscovered booleaninstance object
clientName stringName of the client
instanceName stringName of the instance
displayName stringinstanceId integerInstance ID
instanceGUID stringclientId integerClient ID
appName stringDefault value:
PostgreSQL
Application Name
applicationId integerApplication ID
entityInfo object
companyId integercompanyName stringmultiCommcellId integerindexSettings object
indexRetCycle integeroverrideIndexPruning integerindexRetDays integerindexPruningType integercurrentIndexServer object
clientId integerclientName stringqualifyingIndexServers object[]
clientId integerclientName stringpostGreSQLInstance object
BinaryDirectory stringBinary directory Path
ArchiveDelete booleanArchive delete flag
useGCPApi booleanArchiveLogDirectory stringArchive log directory Path
isStandBy booleanlastLogNumber stringMaintainenceDB stringPostgreSQL maintainence DB
useClientCloudCredentials booleanplanSchedAssocType integerLibDirectory stringLibdirectory Path
port stringPort of the PostgreSQL server
sslOpt object
sslCa stringsslEnabled booleansslKey stringsslCert stringlogStoragePolicy object
storagePolicyName stringStorage policy name associated with the instance
storagePolicyId integerUNCUser object
userName stringstandbyOptions object
useMasterForLogBkp booleanisStandbyEnabled booleanuseMasterForDataBkp booleanstandbyInstance object
instanceName stringinstanceId integerSAUser object
userName stringosUser object
userName stringgcpOptions object
stagingBucketURI stringdumpFileType integeruseCompression booleanclusterSettings objectinstanceActivityControl object
activityControlOptions object[]
activityType integerenableAfterADelay booleanenableActivityType booleancloudDBInstance object
overRideAccessNode booleanaccessNodes object
{
"instanceProperties": [
{
"isDeleted": true,
"applicationSize": 0,
"excludeFromSLA": true,
"version": "string",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": true,
"instance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"instanceGUID": "string",
"clientId": 0,
"appName": "PostgreSQL",
"applicationId": 0,
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"indexSettings": {
"indexRetCycle": 0,
"overrideIndexPruning": 0,
"indexRetDays": 0,
"indexPruningType": 0,
"currentIndexServer": {
"clientId": 0,
"clientName": "string"
},
"qualifyingIndexServers": [
{
"clientId": 0,
"clientName": "string"
}
]
},
"postGreSQLInstance": {
"BinaryDirectory": "string",
"ArchiveDelete": true,
"useGCPApi": true,
"ArchiveLogDirectory": "string",
"isStandBy": true,
"lastLogNumber": "string",
"MaintainenceDB": "string",
"useClientCloudCredentials": true,
"planSchedAssocType": 0,
"LibDirectory": "string",
"port": "string",
"sslOpt": {
"sslCa": "string",
"sslEnabled": true,
"sslKey": "string",
"sslCert": "string"
},
"logStoragePolicy": {
"storagePolicyName": "string",
"storagePolicyId": 0
},
"UNCUser": {
"userName": "string"
},
"standbyOptions": {
"useMasterForLogBkp": true,
"isStandbyEnabled": true,
"useMasterForDataBkp": true,
"standbyInstance": {
"instanceName": "string",
"instanceId": 0
}
},
"SAUser": {
"userName": "string"
},
"osUser": {
"userName": "string"
},
"gcpOptions": {
"stagingBucketURI": "string",
"dumpFileType": 0,
"useCompression": true
},
"clusterSettings": {}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"cloudDBInstance": {
"overRideAccessNode": true,
"accessNodes": {}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"applicationSize": 813694976,
"excludeFromSLA": false,
"version": "10.12",
"scIdxEnabled": 0,
"isSnapEnabled": false,
"autoDiscovered": false,
"instance": {
"clientName": "pgauto1",
"instanceName": "pgauto1_5432",
"displayName": "pgauto1",
"instanceId": 13,
"instanceGUID": "86FCB756-F53C-47AF-AD91-7B090A094F65",
"clientId": 4,
"appName": "PostgreSQL",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"indexSettings": {
"indexRetCycle": -1,
"overrideIndexPruning": 0,
"indexRetDays": -1,
"indexPruningType": 0,
"currentIndexServer": {
"clientId": 2,
"clientName": "bdcdbcs"
},
"qualifyingIndexServers": [
{
"clientId": 2,
"clientName": "bdcdbcs"
}
]
},
"postGreSQLInstance": {
"BinaryDirectory": "/usr/pgsql-10/bin",
"ArchiveDelete": true,
"useGCPApi": false,
"ArchiveLogDirectory": "/var/lib/pgsql/10/wal",
"isStandBy": false,
"lastLogNumber": "0000020B0000000F000000B4",
"MaintainenceDB": "postgres",
"useClientCloudCredentials": false,
"planSchedAssocType": 0,
"LibDirectory": "/usr/pgsql-10/lib",
"port": "5432",
"sslOpt": {
"sslCa": "",
"sslEnabled": false,
"sslKey": "",
"sslCert": ""
},
"logStoragePolicy": {
"storagePolicyName": "gk_pgsql_trad",
"storagePolicyId": 6
},
"UNCUser": {
"userName": ""
},
"standbyOptions": {
"useMasterForLogBkp": false,
"isStandbyEnabled": false,
"useMasterForDataBkp": false,
"standbyInstance": {
"instanceName": "DefaultInstanceName",
"instanceId": 1
}
},
"SAUser": {
"userName": "postgres"
},
"osUser": {
"userName": "postgres"
},
"gcpOptions": {
"stagingBucketURI": "",
"dumpFileType": 0,
"useCompression": false
},
"clusterSettings": {}
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"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
}
Loading...