dbaas

Get a DBaaS PostgreSQL service

Get a DBaaS PostgreSQL service

get/dbaas-postgres/{name}

Request

Path parameters

namestring required

Response

200

updated-atstring date-time

Service last update timestamp (ISO 8601)

node-countinteger

Number of service nodes in the active plan

node-cpu-countinteger

Number of CPUs for each node

zonestring

The zone where the service is running

namestring required
typestring required
state'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
databasesDbaasDatabaseName[]

List of PostgreSQL databases

ip-filterstring[]

Allowed CIDR address blocks for incoming connections

termination-protectionboolean

Service is protected against termination and powering off

synchronous-replication'quorum' | 'off'
disk-sizeinteger

TODO UNIT disk space for data storage

node-memoryinteger

TODO UNIT of memory for each node

uristring

URI for connecting to the service (may be absent)

uri-paramsobject

service_uri parameterized into key-value pairs

versionstring

PostgreSQL version

created-atstring date-time

Service creation timestamp (ISO 8601)

planstring required

Subscription plan

work-meminteger

Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).

shared-buffers-percentageinteger

Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.

max-connectionsinteger

Maximum number of connections allowed to an instance

Example response

{
  "pgbouncer-settings": {
    "ignore_startup_parameters": [
      "extra_float_digits",
      "search_path"
    ],
    "server_lifetime": 3600,
    "autodb_pool_mode": "session",
    "server_idle_timeout": 600,
    "max_prepared_statements": 100,
    "autodb_idle_timeout": 3600
  },
  "timescaledb-settings": {
    "max_background_workers": 8
  },
  "pg-settings": {
    "track_activity_query_size": 1024,
    "timezone": "Europe/Helsinki",
    "track_io_timing": "off",
    "pg_stat_monitor.pgsm_max_buckets": 10,
    "wal": {
      "wal_writer_delay": 50
    },
    "default_toast_compression": "lz4",
    "deadlock_timeout": 1000,
    "autovacuum": {
      "autovacuum_freeze_max_age": 200000000
    },
    "password_encryption": "scram-sha-256",
    "pg_partman_bgw.interval": 3600,
    "track_commit_timestamp": "off",
    "pg_partman_bgw.role": "myrolename",
    "temp_file_limit": 5000000,
    "jit": true,
    "bg-writer": {
      "bgwriter_delay": 200,
      "bgwriter_flush_after": 512,
      "bgwriter_lru_maxpages": 100,
      "bgwriter_lru_multiplier": 2
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.