Managed Service for PostgreSQL API, gRPC: ClusterService
- Calls ClusterService
- Get
- List
- Create
- CreateClusterRequest
- ConfigSpec
- ConnectionPoolerConfig
- Resources
- Access
- PerformanceDiagnostics
- DiskSizeAutoscaling
- DatabaseSpec
- Extension
- UserSpec
- Permission
- UserSettings
- PGAuditSettings
- HostSpec
- ConfigHostSpec
- Operation
- CreateClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Update
- Delete
- Start
- Stop
- Move
- Backup
- Restore
- RescheduleMaintenance
- StartFailover
- ListLogs
- StreamLogs
- ListOperations
- ListBackups
- ListHosts
- AddHosts
- DeleteHosts
- UpdateHosts
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 | Reschedules 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 the previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
ConfigSpec
Field | Description |
---|---|
version | string Version of PostgreSQL used in the cluster. Possible values: 9.6 , 10 , 10_1c , 11 , 12 , 13 , 14 , 15 |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster. |
postgresql_config_12 | PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster. |
postgresql_config_12_1c | PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster. |
postgresql_config_13 | PostgresqlConfig13 Configuration for a PostgreSQL 13 cluster. |
postgresql_config_13_1c | PostgresqlConfig13_1C Configuration for a PostgreSQL 13 1C cluster. |
postgresql_config_14 | PostgresqlConfig14 Configuration for a PostgreSQL 14 cluster. |
postgresql_config_14_1c | PostgresqlConfig14_1C Configuration for a PostgreSQL 14 1C cluster. |
postgresql_config_15 | PostgresqlConfig15 Configuration for a PostgreSQL 15 cluster. |
postgresql_config_15_1c | PostgresqlConfig15_1C Configuration for a PostgreSQL 15 1C cluster. |
postgresql_config_16 | PostgresqlConfig16 Configuration for a PostgreSQL 16 cluster. |
postgresql_config_16_1c | PostgresqlConfig16_1C Configuration for a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
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. |
template_db | string Name of the PostgreSQL database template. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
deletion_protection | google.protobuf.BoolValue Deletion Protection inhibits deletion of the database Default value: unspecified (inherits cluster's deletion_protection) |
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 A set of roles and privileges that are granted to the 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_]* . |
deletion_protection | google.protobuf.BoolValue Deletion Protection inhibits deletion of the user Default value: unspecified (inherits cluster's deletion_protection) |
user_password_encryption | enum UserPasswordEncryption Password-based authentication method for user. Possible values are USER_PASSWORD_ENCRYPTION_MD5 or USER_PASSWORD_ENCRYPTION_SCRAM_SHA_256 . The default is password_encryption setting for cluster. |
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
|
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
|
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
|
pool_mode | enum PoolingMode Mode that the connection pooler is working in with specified user. See in-depth description in Odyssey documentation
|
prepared_statements_pooling | google.protobuf.BoolValue User can use prepared statements with transaction pooling. See in-depth description in PostgreSQL documentation |
catchup_timeout | google.protobuf.Int64Value The connection pooler setting. It determines the maximum allowed replication lag (in seconds). Pooler will reject connections to the replica with a lag above this threshold. It can be useful to prevent application from reading stale data. Default value: 0 Value of 0 disables this mechanism |
wal_sender_timeout | google.protobuf.Int64Value The maximum time (in milliseconds) to wait for WAL replication (can be set only for PostgreSQL 12+) Terminate replication connections that are inactive for longer than this amount of time. Default value: 60000 (60 seconds). Value of 0 disables the timeout mechanism. See in-depth description in PostgreSQL documentation |
idle_in_transaction_session_timeout | google.protobuf.Int64Value Sets the maximum allowed idle time (in milliseconds) between queries, when in a transaction. Values of 0 (default) disables the timeout. See in-depth description in PostgreSQL documentation |
statement_timeout | google.protobuf.Int64Value The maximum time (in milliseconds) to wait for statement The timeout is measured from the time a command arrives at the server until it is completed by the server. If log_min_error_statement is set to ERROR or lower, the statement that timed out will also be logged. Value of 0 (default) disables the timeout See in-depth description in PostgreSQL documentation |
pgaudit | PGAuditSettings |
PGAuditSettings
Field | Description |
---|---|
log[] | enum PGAuditSettingsLog |
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 Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | 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 | PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. |
postgresql_config_13 | PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. |
postgresql_config_13_1c | PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. |
postgresql_config_14 | PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. |
postgresql_config_14_1c | PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. |
postgresql_config_15 | PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. |
postgresql_config_15_1c | PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. |
postgresql_config_16 | PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. |
postgresql_config_16_1c | PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 New maintenance window settings for the cluster. |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
ConfigSpec
Field | Description |
---|---|
version | string Version of PostgreSQL used in the cluster. Possible values: 9.6 , 10 , 10_1c , 11 , 12 , 13 , 14 , 15 |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster. |
postgresql_config_12 | PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster. |
postgresql_config_12_1c | PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster. |
postgresql_config_13 | PostgresqlConfig13 Configuration for a PostgreSQL 13 cluster. |
postgresql_config_13_1c | PostgresqlConfig13_1C Configuration for a PostgreSQL 13 1C cluster. |
postgresql_config_14 | PostgresqlConfig14 Configuration for a PostgreSQL 14 cluster. |
postgresql_config_14_1c | PostgresqlConfig14_1C Configuration for a PostgreSQL 14 1C cluster. |
postgresql_config_15 | PostgresqlConfig15 Configuration for a PostgreSQL 15 cluster. |
postgresql_config_15_1c | PostgresqlConfig15_1C Configuration for a PostgreSQL 15 1C cluster. |
postgresql_config_16 | PostgresqlConfig16 Configuration for a PostgreSQL 16 cluster. |
postgresql_config_16_1c | PostgresqlConfig16_1C Configuration for a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). 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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 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 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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 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 if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the PostgreSQL cluster that is being backed up. |
backup_id | string ID of the PostgreSQL backup 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 Timestamp of the moment to which the PostgreSQL cluster should be restored. |
time_inclusive | bool Flag that indicates whether a database should be restored to the first backup point available just after the timestamp specified in the time field instead of just before. Possible values:
|
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 Required. Deployment environment of the new PostgreSQL cluster. |
config_spec | ConfigSpec Required. 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 |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
ConfigSpec
Field | Description |
---|---|
version | string Version of PostgreSQL used in the cluster. Possible values: 9.6 , 10 , 10_1c , 11 , 12 , 13 , 14 , 15 |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster. |
postgresql_config_12 | PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster. |
postgresql_config_12_1c | PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster. |
postgresql_config_13 | PostgresqlConfig13 Configuration for a PostgreSQL 13 cluster. |
postgresql_config_13_1c | PostgresqlConfig13_1C Configuration for a PostgreSQL 13 1C cluster. |
postgresql_config_14 | PostgresqlConfig14 Configuration for a PostgreSQL 14 cluster. |
postgresql_config_14_1c | PostgresqlConfig14_1C Configuration for a PostgreSQL 14 1C cluster. |
postgresql_config_15 | PostgresqlConfig15 Configuration for a PostgreSQL 15 cluster. |
postgresql_config_15_1c | PostgresqlConfig15_1C Configuration for a PostgreSQL 15 1C cluster. |
postgresql_config_16 | PostgresqlConfig16 Configuration for a PostgreSQL 16 cluster. |
postgresql_config_16_1c | PostgresqlConfig16_1C Configuration for a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
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 Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | 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 | PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. |
postgresql_config_13 | PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. |
postgresql_config_13_1c | PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. |
postgresql_config_14 | PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. |
postgresql_config_14_1c | PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. |
postgresql_config_15 | PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. |
postgresql_config_15_1c | PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. |
postgresql_config_16 | PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. |
postgresql_config_16_1c | PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
RescheduleMaintenance
Reschedules 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. ID of the PostgreSQL cluster to reschedule the maintenance operation for. The maximum string length in characters is 50. |
reschedule_type | enum RescheduleType Required. The type of reschedule request.
|
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to the past moment of time if reschedule_type.IMMEDIATE reschedule type is chosen. |
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 if operation finished successfully. |
RescheduleMaintenanceMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the PostgreSQL cluster. |
delayed_until | google.protobuf.Timestamp Required. The time until which this maintenance operation is to be delayed. |
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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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 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 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 |
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.
|
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.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string User security groups |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. |
postgresql_config_12 | PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. |
postgresql_config_12_1c | PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. |
postgresql_config_13 | PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. |
postgresql_config_13_1c | PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. |
postgresql_config_14 | PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. |
postgresql_config_14_1c | PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. |
postgresql_config_15 | PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. |
postgresql_config_15_1c | PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. |
postgresql_config_16 | PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. |
postgresql_config_16_1c | PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 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. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
access | Access Access policy to DB |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
disk_size_autoscaling | DiskSizeAutoscaling Disk size autoscaling |
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
|
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 Type of the storage environment for the host. Possible values:
|
Access
Field | Description |
---|---|
data_lens | bool Allow access for DataLens |
web_sql | bool Allow SQL queries to the cluster databases from the management console. See SQL queries in the management console for more details. |
serverless | bool Allow access for Serverless |
data_transfer | bool Allow access for DataTransfer. |
yandex_query | bool Allow access for YandexQuery. |
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. |
DiskSizeAutoscaling
Field | Description |
---|---|
planned_usage_threshold | int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
emergency_usage_threshold | int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. Acceptable values are 0 to 100, inclusive. |
disk_size_limit | int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
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.
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request, in RFC3339 |
to_time | google.protobuf.Timestamp End timestamp for the logs request, in RFC3339 |
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 the 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 |
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
|
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 A filter expression that filters resources listed in the response. The expression must specify:
message.hostname='node1.db.cloud.yandex.net' message.error_severity IN ("ERROR", "FATAL", "PANIC") AND message.hostname = "node1.db.cloud.yandex.net" 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 |
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 the 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 |
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 the 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 Required. 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 |
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. |
size | int64 Size of backup, in bytes |
type | enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
method | enum BackupMethod Method of backup creation
|
journal_size | int64 Size of the journal associated with backup, in bytes |
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 the 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 MDB hosts that exist on the platform, 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.
|
health | enum Health Status code of the aggregated health of the host.
|
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 Type of the storage environment for the host. Possible values:
|
Service
Field | Description |
---|---|
type | enum Type Type of the service provided by the host.
|
health | enum Health Status code of server availability.
|
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | 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 | PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. |
postgresql_config_13 | PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. |
postgresql_config_13_1c | PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. |
postgresql_config_14 | PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. |
postgresql_config_14_1c | PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. |
postgresql_config_15 | PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. |
postgresql_config_15_1c | PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. |
postgresql_config_16 | PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. |
postgresql_config_16_1c | PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 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 Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | 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 | PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. |
postgresql_config_13 | PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. |
postgresql_config_13_1c | PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. |
postgresql_config_14 | PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. |
postgresql_config_14_1c | PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. |
postgresql_config_15 | PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. |
postgresql_config_15_1c | PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. |
postgresql_config_16 | PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. |
postgresql_config_16_1c | PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 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 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 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 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 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. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the PostgreSQL host should be updated. |
assign_public_ip | bool Whether the host should get a public IP address on creation. |
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 , postgresql_config_12_1c , postgresql_config_13 , postgresql_config_13_1c , postgresql_config_14 , postgresql_config_14_1c , postgresql_config_15 , postgresql_config_15_1c , postgresql_config_16 or postgresql_config_16_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 | 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 | PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. |
postgresql_config_13 | PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. |
postgresql_config_13_1c | PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. |
postgresql_config_14 | PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. |
postgresql_config_14_1c | PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. |
postgresql_config_15 | PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. |
postgresql_config_15_1c | PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. |
postgresql_config_16 | PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. |
postgresql_config_16_1c | PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 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 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 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. |