Skip to main content

Get PostgreSQL instance properties​

Select

SaaS
Customer Managed

This operation fetches the PostgreSQL Instance property

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
  • instance object
  • clientName string

    Name of the client

  • instanceName string

    Name of the instance

  • displayName string
  • instanceId integer

    Instance ID

  • instanceGUID string
  • clientId integer

    Client ID

  • appName string

    Default value: PostgreSQL

    Application Name

  • applicationId integer

    Application ID

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • indexSettings object
  • indexRetCycle integer
  • overrideIndexPruning integer
  • indexRetDays integer
  • indexPruningType integer
  • currentIndexServer object
  • clientId integer
  • clientName string
  • qualifyingIndexServers object[]
  • clientId integer
  • clientName string
  • postGreSQLInstance object
  • BinaryDirectory string

    Binary directory Path

  • ArchiveDelete boolean

    Archive delete flag

  • useGCPApi boolean
  • ArchiveLogDirectory string

    Archive log directory Path

  • isStandBy boolean
  • lastLogNumber string
  • MaintainenceDB string

    PostgreSQL maintainence DB

  • useClientCloudCredentials boolean
  • planSchedAssocType integer
  • LibDirectory string

    Libdirectory Path

  • port string

    Port of the PostgreSQL server

  • sslOpt object
  • sslCa string
  • sslEnabled boolean
  • sslKey string
  • sslCert string
  • logStoragePolicy object
  • storagePolicyName string

    Storage policy name associated with the instance

  • 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
  • clusterSettings object
  • instanceActivityControl object
  • activityControlOptions object[]
  • activityType integer
  • enableAfterADelay boolean
  • enableActivityType boolean
  • cloudDBInstance object
  • overRideAccessNode boolean
  • accessNodes object
Loading...