Get started
Log in
Yandex Managed Service for PostgreSQL

Method listHosts

Retrieves a list of hosts for the specified cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/hosts

Path parameters

Parameter Description
clusterId Required. ID of the PostgreSQL cluster. To get the PostgreSQL cluster ID use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

 {
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "role": "string",
      "health": "string",
      "services": [
        {
          "type": "string",
          "health": "string"
        }
      ],
      "subnetId": "string",
      "replicationSource": "string",
      "priority": "integer",
      "config": {

        // `hosts[].config`includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10`
        "postgresqlConfig_9_6": {
          "recoveryMinApplyDelay": "integer",
          "sharedBuffers": "integer",
          "tempBuffers": "integer",
          "workMem": "integer",
          "replacementSortTuples": "integer",
          "tempFileLimit": "integer",
          "backendFlushAfter": "integer",
          "oldSnapshotThreshold": "integer",
          "maxStandbyStreamingDelay": "integer",
          "constraintExclusion": "string",
          "cursorTupleFraction": "number",
          "fromCollapseLimit": "integer",
          "joinCollapseLimit": "integer",
          "forceParallelMode": "string",
          "clientMinMessages": "string",
          "logMinMessages": "string",
          "logMinErrorStatement": "string",
          "logMinDurationStatement": "integer",
          "logCheckpoints": true,
          "logConnections": true,
          "logDisconnections": true,
          "logDuration": true,
          "logErrorVerbosity": "string",
          "logLockWaits": true,
          "logStatement": "string",
          "logTempFiles": "integer",
          "searchPath": "string",
          "rowSecurity": true,
          "defaultTransactionIsolation": "string",
          "statementTimeout": "integer",
          "lockTimeout": "integer",
          "idleInTransactionSessionTimeout": "integer",
          "byteaOutput": "string",
          "xmlbinary": "string",
          "xmloption": "string",
          "ginPendingListLimit": "integer",
          "deadlockTimeout": "integer",
          "maxLocksPerTransaction": "integer",
          "maxPredLocksPerTransaction": "integer",
          "arrayNulls": true,
          "backslashQuote": "string",
          "defaultWithOids": true,
          "escapeStringWarning": true,
          "loCompatPrivileges": true,
          "operatorPrecedenceWarning": true,
          "quoteAllIdentifiers": true,
          "standardConformingStrings": true,
          "synchronizeSeqscans": true,
          "transformNullEquals": true,
          "exitOnError": true,
          "seqPageCost": "number",
          "randomPageCost": "number",
          "sqlInheritance": true
        },
        "postgresqlConfig_10": {
          "recoveryMinApplyDelay": "integer",
          "sharedBuffers": "integer",
          "tempBuffers": "integer",
          "workMem": "integer",
          "replacementSortTuples": "integer",
          "tempFileLimit": "integer",
          "backendFlushAfter": "integer",
          "oldSnapshotThreshold": "integer",
          "maxStandbyStreamingDelay": "integer",
          "constraintExclusion": "string",
          "cursorTupleFraction": "number",
          "fromCollapseLimit": "integer",
          "joinCollapseLimit": "integer",
          "forceParallelMode": "string",
          "clientMinMessages": "string",
          "logMinMessages": "string",
          "logMinErrorStatement": "string",
          "logMinDurationStatement": "integer",
          "logCheckpoints": true,
          "logConnections": true,
          "logDisconnections": true,
          "logDuration": true,
          "logErrorVerbosity": "string",
          "logLockWaits": true,
          "logStatement": "string",
          "logTempFiles": "integer",
          "searchPath": "string",
          "rowSecurity": true,
          "defaultTransactionIsolation": "string",
          "statementTimeout": "integer",
          "lockTimeout": "integer",
          "idleInTransactionSessionTimeout": "integer",
          "byteaOutput": "string",
          "xmlbinary": "string",
          "xmloption": "string",
          "ginPendingListLimit": "integer",
          "deadlockTimeout": "integer",
          "maxLocksPerTransaction": "integer",
          "maxPredLocksPerTransaction": "integer",
          "arrayNulls": true,
          "backslashQuote": "string",
          "defaultWithOids": true,
          "escapeStringWarning": true,
          "loCompatPrivileges": true,
          "operatorPrecedenceWarning": true,
          "quoteAllIdentifiers": true,
          "standardConformingStrings": true,
          "synchronizeSeqscans": true,
          "transformNullEquals": true,
          "exitOnError": true,
          "seqPageCost": "number",
          "randomPageCost": "number"
        },
        // end of the list of possible fields`hosts[].config`

      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
hosts[] object

List of Host resources.
hosts[].
name		 string

Name of the PostgreSQL host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all existing MDB hosts in Yandex.Cloud, as it defines the FQDN of the host.
hosts[].
clusterId		 string

ID of the PostgreSQL host. The ID is assigned by MDB at creation time.
hosts[].
zoneId		 string

ID of the availability zone where the PostgreSQL host resides.
hosts[].
resources		 object

Resources allocated to the PostgreSQL host.
hosts[].
resources.
resourcePresetId		 string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
hosts[].
resources.
diskSize		 string (int64)

Volume of the storage available to a host, in bytes.
hosts[].
resources.
diskTypeId		 string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
hosts[].
role		 string

Role of the host in the cluster.

  • ROLE_UNKNOWN: Role of the host in the cluster is unknown.
  • MASTER: Host is the master PostgreSQL server in the cluster.
  • REPLICA: Host is a replica (standby) PostgreSQL server in the cluster.
hosts[].
health		 string

Status code of the aggregated health of the host.

  • HEALTH_UNKNOWN: Health of the host is unknown.
  • ALIVE: The host is performing all its functions normally.
  • DEAD: The host is inoperable, and cannot perform any of its essential functions.
  • DEGRADED: The host is degraded, and can perform only some of its essential functions.
hosts[].
services[]		 object

Services provided by the host.
hosts[].
services[].
type		 string

Type of the service provided by the host.

  • POSTGRESQL: The host is a PostgreSQL server.
  • POOLER: The host is a PgBouncer server.
hosts[].
services[].
health		 string

Status code of server availability.

  • HEALTH_UNKNOWN: Health of the server is unknown.
  • ALIVE: The server is working normally.
  • DEAD: The server is dead or unresponsive.
hosts[].
subnetId		 string

ID of the subnet that the host belongs to.
hosts[].
replicationSource		 string

Name of the host to be used as the replication source for cascading replication.
hosts[].
priority		 integer (int64)

Priority of the host as a replica. Higher value means higher priority.

The host with the highest priority is the synchronous replica. All others are asynchronous. The synchronous replica replaces the master when needed.

When a replica becomes the master, its priority is ignored.
hosts[].
config		 object

Configuration of a PostgreSQL server for the host.
hosts[].
config.
postgresqlConfig_9_6		 object
hosts[].config includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10

Options and structure of PostgresqlHostConfig reflects parameters of a PostgreSQL configuration file. Detailed description is available in PostgreSQL documentation.
hosts[].
config.
postgresqlConfig_9_6.
recoveryMinApplyDelay		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
sharedBuffers		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
tempBuffers		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
workMem		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
replacementSortTuples		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
tempFileLimit		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
backendFlushAfter		 integer (int64)

Acceptable values are 0 to 2048, inclusive.
hosts[].
config.
postgresqlConfig_9_6.
oldSnapshotThreshold		 integer (int64)

Acceptable values are -1 to 86400, inclusive.
hosts[].
config.
postgresqlConfig_9_6.
maxStandbyStreamingDelay		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
constraintExclusion		 string
hosts[].
config.
postgresqlConfig_9_6.
cursorTupleFraction		 number (double)
hosts[].
config.
postgresqlConfig_9_6.
fromCollapseLimit		 integer (int64)

Acceptable values are 1 to 2147483647, inclusive.
hosts[].
config.
postgresqlConfig_9_6.
joinCollapseLimit		 integer (int64)

Acceptable values are 1 to 2147483647, inclusive.
hosts[].
config.
postgresqlConfig_9_6.
forceParallelMode		 string
hosts[].
config.
postgresqlConfig_9_6.
clientMinMessages		 string
hosts[].
config.
postgresqlConfig_9_6.
logMinMessages		 string
hosts[].
config.
postgresqlConfig_9_6.
logMinErrorStatement		 string
hosts[].
config.
postgresqlConfig_9_6.
logMinDurationStatement		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
logCheckpoints		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
logConnections		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
logDisconnections		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
logDuration		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
logErrorVerbosity		 string
hosts[].
config.
postgresqlConfig_9_6.
logLockWaits		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
logStatement		 string
hosts[].
config.
postgresqlConfig_9_6.
logTempFiles		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
searchPath		 string
hosts[].
config.
postgresqlConfig_9_6.
rowSecurity		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
defaultTransactionIsolation		 string
hosts[].
config.
postgresqlConfig_9_6.
statementTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
lockTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
idleInTransactionSessionTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
byteaOutput		 string
hosts[].
config.
postgresqlConfig_9_6.
xmlbinary		 string
hosts[].
config.
postgresqlConfig_9_6.
xmloption		 string
hosts[].
config.
postgresqlConfig_9_6.
ginPendingListLimit		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
deadlockTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
maxLocksPerTransaction		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
maxPredLocksPerTransaction		 integer (int64)
hosts[].
config.
postgresqlConfig_9_6.
arrayNulls		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
backslashQuote		 string
hosts[].
config.
postgresqlConfig_9_6.
defaultWithOids		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
escapeStringWarning		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
loCompatPrivileges		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
operatorPrecedenceWarning		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
quoteAllIdentifiers		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
standardConformingStrings		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
synchronizeSeqscans		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
transformNullEquals		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
exitOnError		 boolean (boolean)
hosts[].
config.
postgresqlConfig_9_6.
seqPageCost		 number (double)
hosts[].
config.
postgresqlConfig_9_6.
randomPageCost		 number (double)
hosts[].
config.
postgresqlConfig_9_6.
sqlInheritance		 boolean (boolean)

This option has been removed in PostgreSQL 10.
hosts[].
config.
postgresqlConfig_10		 object
hosts[].config includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10

Options and structure of PostgresqlHostConfig reflects PostgreSQL configuration file parameters whose detailed description is available in PostgreSQL documentation.
hosts[].
config.
postgresqlConfig_10.
recoveryMinApplyDelay		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
sharedBuffers		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
tempBuffers		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
workMem		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
replacementSortTuples		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
tempFileLimit		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
backendFlushAfter		 integer (int64)

Acceptable values are 0 to 2048, inclusive.
hosts[].
config.
postgresqlConfig_10.
oldSnapshotThreshold		 integer (int64)

Acceptable values are -1 to 86400, inclusive.
hosts[].
config.
postgresqlConfig_10.
maxStandbyStreamingDelay		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
constraintExclusion		 string
hosts[].
config.
postgresqlConfig_10.
cursorTupleFraction		 number (double)
hosts[].
config.
postgresqlConfig_10.
fromCollapseLimit		 integer (int64)

Acceptable values are 1 to 2147483647, inclusive.
hosts[].
config.
postgresqlConfig_10.
joinCollapseLimit		 integer (int64)

Acceptable values are 1 to 2147483647, inclusive.
hosts[].
config.
postgresqlConfig_10.
forceParallelMode		 string
hosts[].
config.
postgresqlConfig_10.
clientMinMessages		 string
hosts[].
config.
postgresqlConfig_10.
logMinMessages		 string
hosts[].
config.
postgresqlConfig_10.
logMinErrorStatement		 string
hosts[].
config.
postgresqlConfig_10.
logMinDurationStatement		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
logCheckpoints		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
logConnections		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
logDisconnections		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
logDuration		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
logErrorVerbosity		 string
hosts[].
config.
postgresqlConfig_10.
logLockWaits		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
logStatement		 string
hosts[].
config.
postgresqlConfig_10.
logTempFiles		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
searchPath		 string
hosts[].
config.
postgresqlConfig_10.
rowSecurity		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
defaultTransactionIsolation		 string
hosts[].
config.
postgresqlConfig_10.
statementTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
lockTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
idleInTransactionSessionTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
byteaOutput		 string
hosts[].
config.
postgresqlConfig_10.
xmlbinary		 string
hosts[].
config.
postgresqlConfig_10.
xmloption		 string
hosts[].
config.
postgresqlConfig_10.
ginPendingListLimit		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
deadlockTimeout		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
maxLocksPerTransaction		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
maxPredLocksPerTransaction		 integer (int64)
hosts[].
config.
postgresqlConfig_10.
arrayNulls		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
backslashQuote		 string
hosts[].
config.
postgresqlConfig_10.
defaultWithOids		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
escapeStringWarning		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
loCompatPrivileges		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
operatorPrecedenceWarning		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
quoteAllIdentifiers		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
standardConformingStrings		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
synchronizeSeqscans		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
transformNullEquals		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
exitOnError		 boolean (boolean)
hosts[].
config.
postgresqlConfig_10.
seqPageCost		 number (double)
hosts[].
config.
postgresqlConfig_10.
randomPageCost		 number (double)
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.