Get PostgreSQL Instances associated to a client
Select
SaaS
Customer Managed
Get the properties of PostgreSQL Instances associated to the client
Query Parameters
- clientName string required
Name of the client
- appName string required
Default value:
PostgreSQL
Application name is PostgreSQL
Responses
- 200
- 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 stringClient name
instanceName stringName of the instance
displayName stringinstanceId integerinstanceGUID stringclientId integerappName stringDefault value:
PostgreSQL
applicationId integerentityInfo object
companyId integercompanyName stringmultiCommcellId integerpostGreSQLInstance object
BinaryDirectory stringBinary directory path
ArchiveDelete booleanArchive delete flag
useGCPApi booleanArchiveLogDirectory stringArchive log directory path
isStandBy booleanlastLogNumber stringLast log number backed up
MaintainenceDB stringuseClientCloudCredentials booleanplanSchedAssocType integerLibDirectory stringLibrary directory path
port stringPort of PostgreSQL instance
sslOpt object
sslCa stringsslEnabled booleansslKey stringsslCert stringlogStoragePolicy object
storagePolicyName stringStorage Policy name
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
}
},
"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": 0,
"excludeFromSLA": false,
"version": "10.18",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "pgauto1v1",
"instanceName": "pgauto1v1_5432",
"displayName": "pgauto1v1",
"instanceId": 66,
"instanceGUID": "EA15C0E1-A767-43F0-A341-46B2FDE11790",
"clientId": 23,
"appName": "PostgreSQL",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"postGreSQLInstance": {
"BinaryDirectory": "/usr/pgsql-10/bin",
"ArchiveDelete": true,
"useGCPApi": false,
"ArchiveLogDirectory": "/var/lib/pgsql/10/wal",
"isStandBy": false,
"lastLogNumber": "0000003600000000000000D7",
"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": {}
}
},
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "10.18",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "pgauto1v1",
"instanceName": "pgauto1v1_blb_5694",
"displayName": "pgauto1v1",
"instanceId": 65,
"instanceGUID": "10BEF831-16F5-40A6-BE2A-6AE366ECF921",
"clientId": 23,
"appName": "PostgreSQL",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"postGreSQLInstance": {
"BinaryDirectory": "/usr/pgsql-10/bin",
"ArchiveDelete": true,
"useGCPApi": false,
"ArchiveLogDirectory": "/var/lib/pgsql/10/wal_blb",
"isStandBy": false,
"lastLogNumber": "000000160000000000000057",
"MaintainenceDB": "postgres",
"useClientCloudCredentials": false,
"planSchedAssocType": 0,
"LibDirectory": "/usr/pgsql-10/lib",
"port": "5694",
"sslOpt": {
"sslCa": "",
"sslEnabled": false,
"sslKey": "",
"sslCert": ""
},
"logStoragePolicy": {
"storagePolicyName": "gk_pgsql_snap",
"storagePolicyId": 7
},
"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": {}
}
},
{
"isDeleted": false,
"applicationSize": 0,
"excludeFromSLA": false,
"version": "10.18",
"scIdxEnabled": 0,
"isSnapEnabled": true,
"autoDiscovered": false,
"instance": {
"clientName": "pgauto1v1",
"instanceName": "pgauto1v1_snap_5594",
"displayName": "pgauto1v1",
"instanceId": 67,
"instanceGUID": "FDF05526-AED9-4BBE-936D-998D87BC5E17",
"clientId": 23,
"appName": "PostgreSQL",
"applicationId": 125,
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"postGreSQLInstance": {
"BinaryDirectory": "/usr/pgsql-10/bin",
"ArchiveDelete": true,
"useGCPApi": false,
"ArchiveLogDirectory": "/var/lib/pgsql/10/wal_snap",
"isStandBy": false,
"lastLogNumber": "000000140000000000000052",
"MaintainenceDB": "postgres",
"useClientCloudCredentials": false,
"planSchedAssocType": 0,
"LibDirectory": "/usr/pgsql-10/lib",
"port": "5594",
"sslOpt": {
"sslCa": "",
"sslEnabled": false,
"sslKey": "",
"sslCert": ""
},
"logStoragePolicy": {
"storagePolicyName": "gk_pgsql_snap",
"storagePolicyId": 7
},
"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": {}
}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Loading...