Skip to main content

Get PostgreSQL Cluster instance properties​

Select

SaaS
Customer Managed

This operation fetches the PostgreSQL Cluster Instance properties

Path Parameters
  • instanceId integer required

    InstanceId of the PostgreSQL Instance

Responses

OK

Schema
  • instanceProperties object[]
  • isDeleted boolean
  • applicationSize integer
  • excludeFromSLA boolean
  • version string
  • scIdxEnabled integer
  • isSnapEnabled boolean
  • autoDiscovered boolean
  • status integer
  • instance object
  • clientName string

    Client Name

  • instanceName string

    Instance Name

  • displayName string
  • instanceId integer
  • instanceGUID string
  • clientId integer
  • appName string

    Default value: PostgreSQL

    PostgreSQL

  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • indexSettings object
  • indexRetCycle integer
  • overrideIndexPruning integer
  • indexRetDays integer
  • indexPruningType integer
  • currentIndexServer object
  • qualifyingIndexServers object[]
  • clientId integer
  • clientName string
  • postGreSQLInstance object
  • BinaryDirectory string
  • ArchiveDelete boolean
  • useGCPApi boolean
  • ArchiveLogDirectory string
  • isStandBy boolean
  • lastLogNumber string
  • MaintainenceDB string
  • useClientCloudCredentials boolean
  • planSchedAssocType integer
  • LibDirectory string
  • port string
  • dbClusterManager integer

    PostgreSQL cluster manager type. 1=Patroni cluster 2=EDB Failover Manager 3=Repmgr for Postgres 4=Native Replication

  • sslOpt object
  • sslCa string
  • sslEnabled boolean
  • sslKey string
  • sslCert string
  • logStoragePolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • UNCUser object
  • userName string
  • standbyOptions object
  • useMasterForLogBkp boolean
  • isStandbyEnabled boolean
  • useMasterForDataBkp boolean
  • standbyInstance object
  • instanceName string
  • instanceId integer
  • SAUser object
  • userName string
  • osUser object
  • userName string
  • gcpOptions object
  • stagingBucketURI string
  • dumpFileType integer
  • useCompression boolean
  • nodes object[]
  • clusterPriority integer

    Cluster priority

  • physicalClient object
  • clientId integer
  • clientName string

    Client name

  • displayName string
  • postgresProps object
  • DBRole integer

    Database role:

    Master: 1, Standby: 2, Unknown: 3

  • BinaryDirectory string

    Binary log directory

  • ArchiveLogDirectory string

    Archive log directory

  • managerBinDir string

    Cluster manager Binary directory

  • MaintainenceDB string

    Maintainence DB

  • LibDirectory string

    Library Directory

  • managerConfig string

    Cluster manager config file path

  • port string

    Database port

  • sslOpt object
  • sslCa string
  • sslEnabled boolean
  • sslKey string
  • sslCert string
  • UNCUser object
  • userName string
  • SAUser object
  • userName string

    Database user

  • osUser object
  • userName string
  • clusterSettings object
  • instanceActivityControl object
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • planEntity object
  • planType integer
  • planName string

    Plan Name

  • planSubtype integer
  • planId integer
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
  • lastBackupJobInfo object
  • jobID integer
  • failureReasonIds string
  • commCellID integer
  • failureReasonMessageEnglish string
  • status integer
  • startTime object
  • time integer
  • endTime object
  • time integer
GET /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
token
instanceId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'