ClusterService

A set of methods for managing PostgreSQL Cluster resources.

Call	Description
Get	Returns the specified PostgreSQL Cluster resource.
List	Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.
Create	Creates a PostgreSQL cluster in the specified folder.
Update	Updates the specified PostgreSQL cluster.
Delete	Deletes the specified PostgreSQL cluster.
Start	Start the specified PostgreSQL cluster.
Stop	Stop the specified PostgreSQL cluster.
Move	Moves the specified PostgreSQL cluster to the specified folder.
Backup	Creates a backup for the specified PostgreSQL cluster.
Restore	Creates a new PostgreSQL cluster using the specified backup.
RescheduleMaintenance	Reschedule planned maintenance operation.
StartFailover	Start a manual failover on the specified PostgreSQL cluster.
ListLogs	Retrieves logs for the specified PostgreSQL cluster.
StreamLogs	Same as ListLogs but using server-side streaming.
ListOperations	Retrieves the list of Operation resources for the specified cluster.
ListBackups	Retrieves the list of available backups for the specified PostgreSQL cluster.
ListHosts	Retrieves a list of hosts for the specified cluster.
AddHosts	Creates new hosts for a cluster.
DeleteHosts	Deletes the specified hosts for a cluster.
UpdateHosts	Updates the specified hosts.

Calls ClusterService

Get

Returns the specified PostgreSQL Cluster resource.
To get the list of available PostgreSQL Cluster resources, make a List request.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL Cluster resource to return. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

List

Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

Field	Description
folder_id	string Required. ID of the folder to list PostgreSQL clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string The field name. Currently you can only use filtering with the Cluster.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Мust be 1-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$. The maximum string length in characters is 1000.

ListClustersResponse

Field	Description
clusters[]	Cluster List of PostgreSQL Cluster resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Create

Creates a PostgreSQL cluster in the specified folder.

rpc Create (CreateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateClusterMetadata

    Operation.response:Cluster

CreateClusterRequest

Field	Description
folder_id	string Required. ID of the folder to create the PostgreSQL cluster in. The maximum string length in characters is 50.
name	string Required. Name of the PostgreSQL cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the PostgreSQL cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Required. Deployment environment of the PostgreSQL cluster.
config_spec	ConfigSpec Required. Configuration and resources for hosts that should be created for the PostgreSQL cluster.
database_specs[]	DatabaseSpec Required. Descriptions of databases to be created in the PostgreSQL cluster.
user_specs[]	UserSpec Required. Descriptions of database users to be created in the PostgreSQL cluster.
host_specs[]	HostSpec Required. Individual configurations for hosts that should be created for the PostgreSQL cluster.
network_id	string Required. ID of the network to create the cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string Version of PostgreSQL used in the cluster. Possible values: 9.6, 10, 10_1c, 11, 12.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration of a PostgreSQL cluster.
postgresql_config_9_6	PostgresqlConfig9_6 Configuration for a PostgreSQL 9.6 cluster.
postgresql_config_10_1c	PostgresqlConfig10_1C Configuration for a PostgreSQL 10 1C cluster.
postgresql_config_10	PostgresqlConfig10 Configuration for a PostgreSQL 10 cluster.
postgresql_config_11	PostgresqlConfig11 Configuration for a PostgreSQL 11 cluster.
postgresql_config_11_1c	config.PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster.
postgresql_config_12	PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster.
postgresql_config_12_1c	config.PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

DatabaseSpec

Field	Description
name	string Required. Name of the PostgreSQL database. 1-63 characters long. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
owner	string Required. Name of the user to be assigned as the owner of the database. To get the list of available PostgreSQL users, make a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
lc_collate	string POSIX locale for string sorting order. Can only be set at creation time. Value must match the regular expression |[a-zA-Z_]+.UTF-8|C.
lc_ctype	string POSIX locale for character classification. Can only be set at creation time. Value must match the regular expression |[a-zA-Z_]+.UTF-8|C.
extensions[]	Extension PostgreSQL extensions to be enabled for the database.

Extension

Field	Description
name	string Name of the extension, e.g. pg_trgm or pg_btree. Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.
version	string Version of the extension.

UserSpec

Field	Description
name	string Required. Name of the PostgreSQL user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
password	string Required. Password of the PostgreSQL user. The string length in characters must be 8-128.
permissions[]	Permission Set of permissions to grant to the user to access specific databases.
conn_limit	google.protobuf.Int64Value Maximum number of database connections that should be available to the user. When used in session pooling, this setting limits the number of connections to every single host in PostgreSQL cluster. In this case, the setting's value must be greater than the total number of connections that backend services can open to access the PostgreSQL cluster. The setting's value should not exceed the value of the Cluster.config.postgresql_config_12.effective_config.max_connections setting. When used in transaction pooling, this setting limits the number of user's active transactions; therefore, in this mode user can open thousands of connections, but only N concurrent connections will be opened, where N is the value of the setting. Minimum value: 10 (default: 50), when used in session pooling. The minimum value is 10.
settings	UserSettings PostgreSQL settings for the user.
login	google.protobuf.BoolValue This flag defines whether the user can login to a PostgreSQL database. Default value: true (login is allowed).
grants[]	string Roles and privileges that are granted to the user (GRANT <role> TO <user>). For more information, see the documentation. The maximum string length in characters for each value is 63. Each value must match the regular expression [a-zA-Z0-9_]*.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
default_transaction_isolation	enum TransactionIsolation SQL sets an isolation level for each transaction. This setting defines the default isolation level to be set for all new SQL transactions. See in-depth description in PostgreSQL documentation. TRANSACTION_ISOLATION_READ_UNCOMMITTED: this level behaves like TRANSACTION_ISOLATION_READ_COMMITTED in PostgreSQL. TRANSACTION_ISOLATION_READ_COMMITTED: (default) on this level query sees only data committed before the query began. TRANSACTION_ISOLATION_REPEATABLE_READ: on this level all subsequent queries in a transaction will see the same rows, that were read by the first SELECT or INSERT query in this transaction, unchanged (these rows are locked during the first query). TRANSACTION_ISOLATION_SERIALIZABLE: this level provides the strictest transaction isolation. All queries in the current transaction see only the rows that were fixed prior to execution of the first SELECT or INSERT query in this transaction. If read and write operations in a concurrent set of serializable transactions overlap and this may cause an inconsistency that is not possible during the serial transaction execution, then one of the transaction will be rolled back, triggering a serialization failure.
lock_timeout	google.protobuf.Int64Value The maximum time (in milliseconds) for any statement to wait for acquiring a lock on an table, index, row or other database object. If the wait time is longer than the specified amount, then this statement is aborted. Default value: 0 (no control is enforced, a statement waiting time is unlimited).
log_min_duration_statement	google.protobuf.Int64Value This setting controls logging of the duration of statements. The duration of each completed statement will be logged if the statement ran for at least the specified amount of time (in milliseconds). E.g., if this setting's value is set to 500, a statement that took 300 milliseconds to complete will not be logged; on the other hand, the one that took 2000 milliseconds to complete, will be logged. Value of 0 forces PostgreSQL to log the duration of all statements. Value of -1 (default) disables logging of the duration of statements. See in-depth description in PostgreSQL documentation.
synchronous_commit	enum SynchronousCommit This setting defines whether DBMS will commit transaction in a synchronous way. When synchronization is enabled, cluster waits for the synchronous operations to be completed prior to reporting success to the client. These operations guarantee different levels of the data safety and visibility in the cluster. See in-depth description in PostgreSQL documentation. SYNCHRONOUS_COMMIT_ON: (default value) success is reported to the client if the data is in WAL (Write-Ahead Log), and WAL is written to the storage of both the master and its synchronous standby server. SYNCHRONOUS_COMMIT_OFF: success is reported to the client even if the data is not in WAL. There is no synchronous write operation, data may be loss in case of storage subsystem failure. SYNCHRONOUS_COMMIT_LOCAL: success is reported to the client if the data is in WAL, and WAL is written to the storage of the master server. The transaction may be lost due to storage subsystem failure on the master server. SYNCHRONOUS_COMMIT_REMOTE_WRITE: success is reported to the client if the data is in WAL, WAL is written to the storage of the master server, and the server's synchronous standby indicates that it has received WAL and written it out to its operating system. The transaction may be lost due to simultaneous storage subsystem failure on the master and operating system's failure on the synchronous standby. SYNCHRONOUS_COMMIT_REMOTE_APPLY: success is reported to the client if the data is in WAL (Write-Ahead Log), WAL is written to the storage of the master server, and its synchronous standby indicates that it has received WAL and applied it. The transaction may be lost due to irrecoverably failure of both the master and its synchronous standby.
temp_file_limit	google.protobuf.Int64Value The maximum storage space size (in kilobytes) that a single process can use to create temporary files. If a transaction exceeds this limit during execution, it will be aborted. A huge query may not fit into a server's RAM, therefore PostgreSQL will use some storage to store and execute such a query. Too big queries can make excessive use of the storage system, effectively making other quieries to run slow. This setting prevents execution of a big queries that can influence other queries by limiting size of temporary files.
log_statement	enum LogStatement This setting specifies which SQL statements should be logged (on the user level). See in-depth description in PostgreSQL documentation. LOG_STATEMENT_NONE: (default) logs none of SQL statements. LOG_STATEMENT_DDL: logs all data definition statements (such as CREATE, ALTER, DROP and others). LOG_STATEMENT_MOD: logs all statements that fall in the LOG_STATEMENT_DDL category plus data-modifying statements (such as INSERT, UPDATE and others). LOG_STATEMENT_ALL: logs all SQL statements.

HostSpec

Field	Description
zone_id	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. The maximum string length in characters is 50.
subnet_id	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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.
replication_source	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.
config_spec	ConfigHostSpec Configuration of a PostgreSQL server for the host.

ConfigHostSpec

Field	Description
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c
postgresql_config_9_6	PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed.
postgresql_config_10_1c	PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed.
postgresql_config_10	PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed.
postgresql_config_11	PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed.
postgresql_config_11_1c	config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed.
postgresql_config_12	PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed.
postgresql_config_12_1c	config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<CreateClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

CreateClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster that is being created.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Update

Updates the specified PostgreSQL cluster.

rpc Update (UpdateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterMetadata

    Operation.response:Cluster

UpdateClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL Cluster resource to update. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the PostgreSQL Cluster resource should be updated.
description	string New description of the PostgreSQL cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
config_spec	ConfigSpec New configuration and resources for hosts in the cluster.
name	string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
maintenance_window	MaintenanceWindow Window of maintenance operations.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string Version of PostgreSQL used in the cluster. Possible values: 9.6, 10, 10_1c, 11, 12.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration of a PostgreSQL cluster.
postgresql_config_9_6	PostgresqlConfig9_6 Configuration for a PostgreSQL 9.6 cluster.
postgresql_config_10_1c	PostgresqlConfig10_1C Configuration for a PostgreSQL 10 1C cluster.
postgresql_config_10	PostgresqlConfig10 Configuration for a PostgreSQL 10 cluster.
postgresql_config_11	PostgresqlConfig11 Configuration for a PostgreSQL 11 cluster.
postgresql_config_11_1c	config.PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster.
postgresql_config_12	PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster.
postgresql_config_12_1c	config.PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<UpdateClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

UpdateClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL Cluster resource that is being updated.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Delete

Deletes the specified PostgreSQL cluster.

rpc Delete (DeleteClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to delete. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<DeleteClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster that is being deleted.

Start

Start the specified PostgreSQL cluster.

rpc Start (StartClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterMetadata

    Operation.response:Cluster

StartClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to start. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<StartClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Stop

Stop the specified PostgreSQL cluster.

rpc Stop (StopClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopClusterMetadata

    Operation.response:Cluster

StopClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to stop. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<StopClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StopClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Move

Moves the specified PostgreSQL cluster to the specified folder.

rpc Move (MoveClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveClusterMetadata

    Operation.response:Cluster

MoveClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to move. The maximum string length in characters is 50.
destination_folder_id	string Required. ID of the destination folder. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<MoveClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

MoveClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster being moved.
source_folder_id	string ID of the source folder.
destination_folder_id	string ID of the destnation folder.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Backup

Creates a backup for the specified PostgreSQL cluster.

rpc Backup (BackupClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:BackupClusterMetadata

    Operation.response:Cluster

BackupClusterRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to back up. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<BackupClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

BackupClusterMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster that is being backed up.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

Restore

Creates a new PostgreSQL cluster using the specified backup.

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestoreClusterMetadata

    Operation.response:Cluster

RestoreClusterRequest

Field	Description
backup_id	string Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.
time	google.protobuf.Timestamp Required. Timestamp of the moment to which the PostgreSQL cluster should be restored.
time_inclusive	bool false (default) — the restore point refers to the first backup moment before time. true — the restore point refers to the first backup point after time.
name	string Required. Name of the new PostgreSQL cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the new PostgreSQL cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Deployment environment of the new PostgreSQL cluster.
config_spec	ConfigSpec Configuration for the PostgreSQL cluster to be created.
host_specs[]	HostSpec Configurations for PostgreSQL hosts that should be created for the cluster that is being created from the backup. The number of elements must be greater than 0.
network_id	string Required. ID of the network to create the PostgreSQL cluster in. The maximum string length in characters is 50.
folder_id	string ID of the folder to create the PostgreSQL cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups

ConfigSpec

Field	Description
version	string Version of PostgreSQL used in the cluster. Possible values: 9.6, 10, 10_1c, 11, 12.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration of a PostgreSQL cluster.
postgresql_config_9_6	PostgresqlConfig9_6 Configuration for a PostgreSQL 9.6 cluster.
postgresql_config_10_1c	PostgresqlConfig10_1C Configuration for a PostgreSQL 10 1C cluster.
postgresql_config_10	PostgresqlConfig10 Configuration for a PostgreSQL 10 cluster.
postgresql_config_11	PostgresqlConfig11 Configuration for a PostgreSQL 11 cluster.
postgresql_config_11_1c	config.PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster.
postgresql_config_12	PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster.
postgresql_config_12_1c	config.PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

HostSpec

Field	Description
zone_id	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. The maximum string length in characters is 50.
subnet_id	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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.
replication_source	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.
config_spec	ConfigHostSpec Configuration of a PostgreSQL server for the host.

ConfigHostSpec

Field	Description
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c
postgresql_config_9_6	PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed.
postgresql_config_10_1c	PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed.
postgresql_config_10	PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed.
postgresql_config_11	PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed.
postgresql_config_11_1c	config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed.
postgresql_config_12	PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed.
postgresql_config_12_1c	config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<RestoreClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RestoreClusterMetadata

Field	Description
cluster_id	string ID of the new PostgreSQL cluster that is being created from a backup.
backup_id	string ID of the backup that is being used for creating a cluster.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

RescheduleMaintenance

Reschedule planned maintenance operation.

rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RescheduleMaintenanceMetadata

    Operation.response:Cluster

RescheduleMaintenanceRequest

Field	Description
cluster_id	string Required. Required. ID of the PostgreSQL cluster to maintenance reschedule. The maximum string length in characters is 50.
reschedule_type	enum RescheduleType Required. Required. The type of reschedule request.
delayed_until	google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<RescheduleMaintenanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RescheduleMaintenanceMetadata

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster.
delayed_until	google.protobuf.Timestamp Required. New time of the planned maintenance. Can be in the past for rescheduled to "IMMEDIATE".

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

StartFailover

Start a manual failover on the specified PostgreSQL cluster.

rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterFailoverMetadata

    Operation.response:Cluster

StartClusterFailoverRequest

Field	Description
cluster_id	string Required. ID of PostgreSQL cluster. The maximum string length in characters is 50.
host_name	string New master host. Switch to the most up-to-date replica if not provided. The maximum string length in characters is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<StartClusterFailoverMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterFailoverMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster being failovered.

Cluster

Field	Description
id	string ID of the PostgreSQL cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the PostgreSQL cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
name	string Name of the PostgreSQL cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the PostgreSQL cluster. 0-256 characters long.
labels	map<string,string> Custom labels for the PostgreSQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment Deployment environment of the PostgreSQL cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the PostgreSQL cluster.
config	ClusterConfig Configuration of the PostgreSQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health Aggregated cluster health. HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD). DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. STATUS_UNKNOWN: Cluster state is unknown. CREATING: Cluster is being created. RUNNING: Cluster is running normally. ERROR: Cluster encountered a problem and cannot operate. UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.
maintenance_window	MaintenanceWindow Window of maintenance operations.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
security_group_ids[]	string User security groups

Monitoring

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the PostgreSQL cluster.

ClusterConfig

Field	Description
version	string Version of PostgreSQL server software.
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration for PostgreSQL servers in the cluster.
postgresql_config_9_6	PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server.
postgresql_config_10_1c	PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server.
postgresql_config_10	PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server.
postgresql_config_11	PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server.
postgresql_config_11_1c	config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server.
postgresql_config_12	PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server.
postgresql_config_12_1c	config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server.
pooler_config	ConnectionPoolerConfig Configuration of the connection pooler.
resources	Resources Resources allocated to PostgreSQL hosts.
autofailover	google.protobuf.BoolValue Configuration setting which enables/disables autofailover in cluster.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
performance_diagnostics	PerformanceDiagnostics Configuration of the performance diagnostics service.

ConnectionPoolerConfig

Field	Description
pooling_mode	enum PoolingMode Mode that the connection pooler is working in. See descriptions of all modes in the documentation for PgBouncer. SESSION: Session pooling mode. TRANSACTION: Transaction pooling mode. STATEMENT: Statement pooling mode.
pool_discard	google.protobuf.BoolValue Setting server_reset_query_always parameter in PgBouncer.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string network-hdd — network HDD drive, network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens
web_sql	bool Allow SQL queries to the cluster databases from the Yandex.Cloud management console. See SQL queries in the management console for more details.

PerformanceDiagnostics

Field	Description
enabled	bool Configuration setting which enables/disables performance diagnostics service in cluster.
sessions_sampling_interval	int64 Interval (in seconds) for pg_stat_activity sampling Acceptable values are 1 to 86400, inclusive.
statements_sampling_interval	int64 Interval (in seconds) for pg_stat_statements sampling Acceptable values are 1 to 86400, inclusive.

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window
anytime	AnytimeMaintenanceWindow
weekly_maintenance_window	WeeklyMaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay
hour	int64 Hour of the day in UTC. Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp

ListLogs

Retrieves logs for the specified PostgreSQL cluster.

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to request logs for. To get the PostgreSQL cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
column_filter[]	string Columns from the logs table to request. If no columns are specified, entire log records are returned.
service_type	enum ServiceType Type of the service to request logs about. POSTGRESQL: Logs of PostgreSQL activity. POOLER: Logs of connection pooler activity.
from_time	google.protobuf.Timestamp Start timestamp for the logs request, in RFC3339 text format.
to_time	google.protobuf.Timestamp End timestamp for the logs request, in RFC3339 text format.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
always_next_page_token	bool Always return next_page_token, even if current page is empty.

ListClusterLogsResponse

Field	Description
logs[]	LogRecord Requested log records.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. This value is interchangeable with next_record_token from StreamLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

StreamLogs

Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

Field	Description
cluster_id	string Required. Required. ID of the PostgreSQL cluster. The maximum string length in characters is 50.
column_filter[]	string Columns from logs table to get in the response.
service_type	enum ServiceType POSTGRESQL: Logs of PostgreSQL activity. POOLER: Logs of connection pooler activity.
from_time	google.protobuf.Timestamp Start timestamp for the logs request.
to_time	google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs will be sent and then the new ones as they appear. In essence it has 'tail -f' semantics.
record_token	string Record token. Set record_token to the next_record_token returned by a previous StreamLogs request to start streaming from next log record. The maximum string length in characters is 100.
filter	string The field name. Currently filtering can be applied to the LogRecord.logs.message.hostname, A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Must be 1-63 characters long and match the regular expression ^[a-z0-9.-]{1,61}$. The maximum string length in characters is 1000.

StreamLogRecord

Field	Description
record	LogRecord One of the requested log records.
next_record_token	string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as value for record_token parameter in the next StreamLogs request. This value is interchangeable with next_page_token from ListLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

ListOperations

Retrieves the list of Operation resources for the specified cluster.

rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

ListClusterOperationsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL Cluster resource to list operations for. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterOperationsResponse

Field	Description
operations[]	operation.Operation List of Operation resources for the specified PostgreSQL cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any 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.

ListBackups

Retrieves the list of available backups for the specified PostgreSQL cluster.

rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

ListClusterBackupsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster. To get the PostgreSQL cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterBackupsResponse

Field	Description
backups[]	Backup List of PostgreSQL Backup resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Backup

Field	Description
id	string ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id	string ID of the PostgreSQL cluster that the backup was created for.
started_at	google.protobuf.Timestamp Time when the backup operation was started.

ListHosts

Retrieves a list of hosts for the specified cluster.

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster. To get the PostgreSQL cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterHostsResponse

Field	Description
hosts[]	Host List of Host resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token 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 existing MDB hosts in Yandex.Cloud, as it defines the FQDN of the host.
cluster_id	string ID of the PostgreSQL host. The ID is assigned by MDB at creation time.
zone_id	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. 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.
health	enum Health 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.
services[]	Service Services provided by the host.
subnet_id	string ID of the subnet that the host belongs to.
replication_source	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.
assign_public_ip	bool Flag showing public IP assignment status to this host.
replica_type	enum ReplicaType

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string 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. POSTGRESQL: The host is a PostgreSQL server. POOLER: The host is a PgBouncer server.
health	enum Health 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.

HostConfig

Field	Description
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c Configuration of a PostgreSQL server for the host.
postgresql_config_9_6	PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed.
postgresql_config_10_1c	PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed.
postgresql_config_10	PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed.
postgresql_config_11	PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed.
postgresql_config_11_1c	config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed.
postgresql_config_12	PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed.
postgresql_config_12_1c	config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed.

AddHosts

Creates new hosts for a cluster.

rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AddClusterHostsMetadata

    Operation.response:google.protobuf.Empty

AddClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to add hosts to. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
host_specs[]	HostSpec Configurations for PostgreSQL hosts that should be added to the cluster. The number of elements must be greater than 0.

HostSpec

Field	Description
zone_id	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. The maximum string length in characters is 50.
subnet_id	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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.
replication_source	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.
config_spec	ConfigHostSpec Configuration of a PostgreSQL server for the host.

ConfigHostSpec

Field	Description
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c
postgresql_config_9_6	PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed.
postgresql_config_10_1c	PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed.
postgresql_config_10	PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed.
postgresql_config_11	PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed.
postgresql_config_11_1c	config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed.
postgresql_config_12	PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed.
postgresql_config_12_1c	config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

AddClusterHostsMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster to which the hosts are being added.
host_names[]	string Names of hosts that are being added to the cluster.

DeleteHosts

Deletes the specified hosts for a cluster.

rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterHostsMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to remove hosts from. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
host_names[]	string Names of hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<DeleteClusterHostsMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterHostsMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster to remove hosts from.
host_names[]	string Names of hosts that are being deleted.

UpdateHosts

Updates the specified hosts.

rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterHostsMetadata

    Operation.response:google.protobuf.Empty

UpdateClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the PostgreSQL cluster to update hosts in. To get the PostgreSQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
update_host_specs[]	UpdateHostSpec New configurations to apply to hosts. The number of elements must be greater than 0.

UpdateHostSpec

Field	Description
host_name	string Required. Name of the host to update. To get the PostgreSQL host name, use a ClusterService.ListHosts request.
replication_source	string Host.name of the host to be used as the replication source (for cascading replication). To get the PostgreSQL host name, use a ClusterService.ListHosts request.
priority	google.protobuf.Int64Value 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_spec	ConfigHostSpec Configuration of a PostgreSQL server for the host.

ConfigHostSpec

Field	Description
postgresql_config	oneof: postgresql_config_9_6, postgresql_config_10_1c, postgresql_config_10, postgresql_config_11, postgresql_config_11_1c, postgresql_config_12 or postgresql_config_12_1c
postgresql_config_9_6	PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed.
postgresql_config_10_1c	PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed.
postgresql_config_10	PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed.
postgresql_config_11	PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed.
postgresql_config_11_1c	config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed.
postgresql_config_12	PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed.
postgresql_config_12_1c	config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any<UpdateClusterHostsMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateClusterHostsMetadata

Field	Description
cluster_id	string ID of the PostgreSQL cluster to update hosts in.
host_names[]	string Names of hosts that are being updated.