Contact UsGet started

Managed Service for PostgreSQL API, gRPC: ClusterService.ListHosts

Written by
Updated at October 28, 2024

Retrieves a list of hosts for the specified cluster.

gRPC request

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

{
  "clusterId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster.
To get the PostgreSQL cluster ID use a ClusterService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClusterHostsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClusterHostsResponse.nextPageToken
returned by the previous list request.

ListClusterHostsResponse

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "int64",
        "diskTypeId": "string"
      },
      "role": "Role",
      "health": "Health",
      "services": [
        {
          "type": "Type",
          "health": "Health"
        }
      ],
      "subnetId": "string",
      "replicationSource": "string",
      "priority": "google.protobuf.Int64Value",
      "config": {
        // Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`
        "postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6",
        "postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C",
        "postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10",
        "postgresqlConfig_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11",
        "postgresqlConfig_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C",
        "postgresqlConfig_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12",
        "postgresqlConfig_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C",
        "postgresqlConfig_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13",
        "postgresqlConfig_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C",
        "postgresqlConfig_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14",
        "postgresqlConfig_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C",
        "postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15",
        "postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C",
        "postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16",
        "postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C",
        "postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17",
        "postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C"
        // end of the list of possible fields
      },
      "assignPublicIp": "bool",
      "replicaType": "ReplicaType"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

hosts[]

Host

List of Host resources.

nextPageToken

string

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

Host

Field

Description

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 MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId

string

ID of the PostgreSQL host. The ID is assigned by MDB at creation time.

zoneId

string

ID of the availability zone where the PostgreSQL host resides.

resources

Resources

Resources allocated to the PostgreSQL host.

role

enum Role

Role of the host in the cluster. If the field has default value, it is not returned in the response.

  • ROLE_UNKNOWN: Role of the host in the cluster is unknown. Default value.
  • MASTER: Host is the master PostgreSQL server in the cluster.
  • REPLICA: Host is a replica (standby) PostgreSQL server in the cluster.

health

enum Health

Aggregated health of the host. If the field has default value, it is not returned in the response.

  • HEALTH_UNKNOWN: Health of the host is unknown. Default value.
  • 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.
  • READONLY: The host is alive, but in read-only mode.

services[]

Service

Services provided by the host.

subnetId

string

ID of the subnet that the host belongs to.

replicationSource

string

Name of the host to be used as the replication source for cascading replication.

priority

google.protobuf.Int64Value

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.

config

HostConfig

Configuration of a PostgreSQL server for the host.

assignPublicIp

bool

Flag showing public IP assignment status to this host.

replicaType

enum ReplicaType

  • REPLICA_TYPE_UNKNOWN: Replica type is unknown (we have no data) or it's master
  • ASYNC
  • SYNC
  • QUORUM

Resources

Field

Description

resourcePresetId

string

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

diskSize

int64

Volume of the storage available to a host, in bytes.

diskTypeId

string

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

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

Service

Field

Description

type

enum Type

Type of the service provided by the host. If the field has default value, it is not returned in the response.

  • TYPE_UNSPECIFIED: Service type of the host is unspecified. Default value.
  • POSTGRESQL: The host is a PostgreSQL server.
  • POOLER: The host is a PgBouncer server.

health

enum Health

Aggregated health of the service. If the field has default value, it is not returned in the response.

  • HEALTH_UNKNOWN: Health of the server is unknown. Default value.
  • ALIVE: The server is working normally.
  • DEAD: The server is dead or unresponsive.
  • READONLY: The server is in read-only mode.

HostConfig

Field

Description

postgresqlConfig_9_6

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6

Configuration for a host with PostgreSQL 9.6 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_10_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C

Configuration for a host with PostgreSQL 10 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_10

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10

Configuration for a host with PostgreSQL 10 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_11

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11

Configuration for a host with PostgreSQL 11 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_11_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C

Configuration for a host with PostgreSQL 11 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_12

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12

Configuration for a host with PostgreSQL 12 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_12_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C

Configuration for a host with PostgreSQL 12 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_13

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13

Configuration for a host with PostgreSQL 13 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_13_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C

Configuration for a host with PostgreSQL 13 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_14

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14

Configuration for a host with PostgreSQL 14 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_14_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C

Configuration for a host with PostgreSQL 14 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_15

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15

Configuration for a host with PostgreSQL 15 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_15_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C

Configuration for a host with PostgreSQL 15 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_16

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16

Configuration for a host with PostgreSQL 16 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_16_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C

Configuration for a host with PostgreSQL 16 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_17

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17

Configuration for a host with PostgreSQL 17 server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.

postgresqlConfig_17_1c

yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C

Configuration for a host with PostgreSQL 17 1C server deployed.

Includes only one of the fields postgresqlConfig_9_6, postgresqlConfig_10_1c, postgresqlConfig_10, postgresqlConfig_11, postgresqlConfig_11_1c, postgresqlConfig_12, postgresqlConfig_12_1c, postgresqlConfig_13, postgresqlConfig_13_1c, postgresqlConfig_14, postgresqlConfig_14_1c, postgresqlConfig_15, postgresqlConfig_15_1c, postgresqlConfig_16, postgresqlConfig_16_1c, postgresqlConfig_17, postgresqlConfig_17_1c.

Configuration of a PostgreSQL server for the host.
Previous
ListBackups
Next
AddHosts