Contact UsGet started

Managed Service for PostgreSQL API, gRPC: ClusterService.AddHosts

Written by
Updated at October 28, 2024

Creates new hosts for a cluster.

gRPC request

rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

AddClusterHostsRequest

{
  "clusterId": "string",
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": "bool",
      "replicationSource": "string",
      "priority": "google.protobuf.Int64Value",
      "configSpec": {
        // 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
      }
    }
  ]
}

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster to add hosts to.
To get the PostgreSQL cluster ID, use a ClusterService.List request.

hostSpecs[]

HostSpec

Configurations for PostgreSQL hosts that should be added to the cluster.

HostSpec

Field

Description

zoneId

string

ID of the availability zone where the host resides.
To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnetId

string

ID of the subnet that the host should belong to. This subnet should be a part
of the network that the cluster belongs to.
The ID of the network is set in the field Cluster.networkId.

assignPublicIp

bool

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign
a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

  • false - don't assign a public IP to the host.
  • true - the host should have a public IP address.

replicationSource

string

Host.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. A higher value corresponds to 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.

configSpec

ConfigHostSpec

Configuration of a PostgreSQL server for the host.

ConfigHostSpec

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

postgresqlConfig_17

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

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.

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.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "hostNames": [
      "string"
    ]
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

AddClusterHostsMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

AddClusterHostsMetadata

Field

Description

clusterId

string

ID of the PostgreSQL cluster to which the hosts are being added.

hostNames[]

string

Names of hosts that are being added to the cluster.
Previous
ListHosts
Next
DeleteHosts