Managed Service for PostgreSQL API, gRPC: ClusterService.Restore
- gRPC request
- RestoreClusterRequest
- ConfigSpec
- ConnectionPoolerConfig
- Resources
- Access
- PerformanceDiagnostics
- DiskSizeAutoscaling
- HostSpec
- ConfigHostSpec
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- operation.Operation
- RestoreClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- ConnectionPoolerConfig
- Resources
- Access
- PerformanceDiagnostics
- DiskSizeAutoscaling
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Creates a new PostgreSQL cluster using the specified backup.
gRPC request
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
RestoreClusterRequest
{
"backup_id": "string",
"time": "google.protobuf.Timestamp",
"time_inclusive": "bool",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"environment": "Environment",
"config_spec": {
"version": "string",
// Includes only one of the fields `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`, `postgresql_config_16_1c`, `postgresql_config_17`, `postgresql_config_17_1c`, `postgresql_config_18`, `postgresql_config_18_1c`
"postgresql_config_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6",
"postgresql_config_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C",
"postgresql_config_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10",
"postgresql_config_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11",
"postgresql_config_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C",
"postgresql_config_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12",
"postgresql_config_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C",
"postgresql_config_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13",
"postgresql_config_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C",
"postgresql_config_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14",
"postgresql_config_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C",
"postgresql_config_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15",
"postgresql_config_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C",
"postgresql_config_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16",
"postgresql_config_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C",
"postgresql_config_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17",
"postgresql_config_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C",
"postgresql_config_18": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig18",
"postgresql_config_18_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig18_1C",
// end of the list of possible fields
"pooler_config": {
"pooling_mode": "PoolingMode",
"pool_discard": "google.protobuf.BoolValue"
},
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"autofailover": "google.protobuf.BoolValue",
"backup_window_start": "google.type.TimeOfDay",
"backup_retain_period_days": "google.protobuf.Int64Value",
"access": {
"data_lens": "bool",
"web_sql": "bool",
"serverless": "bool",
"data_transfer": "bool",
"yandex_query": "bool"
},
"performance_diagnostics": {
"enabled": "bool",
"sessions_sampling_interval": "int64",
"statements_sampling_interval": "int64"
},
"disk_size_autoscaling": {
"planned_usage_threshold": "int64",
"emergency_usage_threshold": "int64",
"disk_size_limit": "int64"
}
},
"host_specs": [
{
"zone_id": "string",
"subnet_id": "string",
"assign_public_ip": "bool",
"replication_source": "string",
"priority": "google.protobuf.Int64Value",
"config_spec": {
// Includes only one of the fields `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`, `postgresql_config_16_1c`, `postgresql_config_17`, `postgresql_config_17_1c`, `postgresql_config_18`, `postgresql_config_18_1c`
"postgresql_config_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6",
"postgresql_config_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C",
"postgresql_config_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10",
"postgresql_config_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11",
"postgresql_config_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C",
"postgresql_config_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12",
"postgresql_config_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C",
"postgresql_config_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13",
"postgresql_config_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C",
"postgresql_config_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14",
"postgresql_config_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C",
"postgresql_config_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15",
"postgresql_config_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C",
"postgresql_config_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16",
"postgresql_config_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C",
"postgresql_config_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17",
"postgresql_config_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C",
"postgresql_config_18": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig18",
"postgresql_config_18_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig18_1C"
// end of the list of possible fields
}
}
],
"network_id": "string",
"folder_id": "string",
"security_group_ids": [
"string"
],
"deletion_protection": "bool",
"host_group_ids": [
"string"
],
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"disk_encryption_key_id": "google.protobuf.StringValue"
}
|
Field |
Description |
|
backup_id |
string Required field. ID of the backup to create a cluster from. |
|
time |
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 Possible values:
|
|
name |
string Required field. 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 |
|
description |
string Description of the new PostgreSQL cluster. The maximum string length in characters is 256. |
|
labels |
object (map<string, string>) Custom labels for the PostgreSQL cluster as No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression |
|
environment |
enum Environment Required field. Deployment environment of the new PostgreSQL cluster.
|
|
config_spec |
Required field. Configuration for the PostgreSQL cluster to be created. |
|
host_specs[] |
Configurations for PostgreSQL hosts that should be created for The number of elements must be greater than 0. |
|
network_id |
string Required field. 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. |
|
maintenance_window |
Window of maintenance operations. |
|
disk_encryption_key_id |
ID of the key to encrypt cluster disks. |
ConfigSpec
|
Field |
Description |
|
version |
string Version of PostgreSQL used in the cluster. |
|
postgresql_config_9_6 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6 Configuration for a PostgreSQL 9.6 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_10_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C Configuration for a PostgreSQL 10 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_10 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10 Configuration for a PostgreSQL 10 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_11 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11 Configuration for a PostgreSQL 11 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_11_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C Configuration for a PostgreSQL 11 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_12 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12 Configuration for a PostgreSQL 12 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_12_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C Configuration for a PostgreSQL 12 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_13 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13 Configuration for a PostgreSQL 13 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_13_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C Configuration for a PostgreSQL 13 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_14 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14 Configuration for a PostgreSQL 14 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_14_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C Configuration for a PostgreSQL 14 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_15 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15 Configuration for a PostgreSQL 15 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_15_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C Configuration for a PostgreSQL 15 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_16 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16 Configuration for a PostgreSQL 16 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_16_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C Configuration for a PostgreSQL 16 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_17 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17 Configuration for a PostgreSQL 17 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_17_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C Configuration for a PostgreSQL 17 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_18 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig18 Configuration for a PostgreSQL 18 cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
postgresql_config_18_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig18_1C Configuration for a PostgreSQL 18 1C cluster. Includes only one of the fields Configuration of a PostgreSQL cluster. |
|
pooler_config |
Configuration of the connection pooler. |
|
resources |
Resources allocated to PostgreSQL hosts. |
|
autofailover |
Configuration setting which enables/disables autofailover in cluster. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
backup_retain_period_days |
Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
|
access |
Access policy to DB |
|
performance_diagnostics |
Configuration of the performance diagnostics service. |
|
disk_size_autoscaling |
Disk size autoscaling |
ConnectionPoolerConfig
|
Field |
Description |
|
pooling_mode |
enum PoolingMode Mode that the connection pooler is working in.
|
|
pool_discard |
Setting |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
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.
|
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. 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 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 Possible values:
|
|
replication_source |
string Host.name of the host to be used as the replication source (for cascading replication). |
|
priority |
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. When a replica becomes the master, its priority is ignored. |
|
config_spec |
Configuration of a PostgreSQL server for the host. |
ConfigHostSpec
|
Field |
Description |
|
postgresql_config_9_6 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed. Includes only one of the fields |
|
postgresql_config_10_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed. Includes only one of the fields |
|
postgresql_config_10 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed. Includes only one of the fields |
|
postgresql_config_11 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed. Includes only one of the fields |
|
postgresql_config_11_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed. Includes only one of the fields |
|
postgresql_config_12 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed. Includes only one of the fields |
|
postgresql_config_12_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. Includes only one of the fields |
|
postgresql_config_13 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. Includes only one of the fields |
|
postgresql_config_13_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. Includes only one of the fields |
|
postgresql_config_14 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. Includes only one of the fields |
|
postgresql_config_14_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. Includes only one of the fields |
|
postgresql_config_15 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. Includes only one of the fields |
|
postgresql_config_15_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. Includes only one of the fields |
|
postgresql_config_16 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. Includes only one of the fields |
|
postgresql_config_16_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 1C server deployed. Includes only one of the fields |
|
postgresql_config_17 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17 Configuration for a host with PostgreSQL 17 1C server deployed. Includes only one of the fields |
|
postgresql_config_17_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C Configuration for a host with PostgreSQL 17 1C server deployed. Includes only one of the fields |
|
postgresql_config_18 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig18 Configuration for a host with PostgreSQL 18 1C server deployed. Includes only one of the fields |
|
postgresql_config_18_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig18_1C Configuration for a host with PostgreSQL 18 1C server deployed. Includes only one of the fields |
MaintenanceWindow
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"cluster_id": "string",
"backup_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
// Includes only one of the fields `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`, `postgresql_config_16_1c`, `postgresql_config_17`, `postgresql_config_17_1c`, `postgresql_config_18`, `postgresql_config_18_1c`
"postgresql_config_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6",
"postgresql_config_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C",
"postgresql_config_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10",
"postgresql_config_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11",
"postgresql_config_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C",
"postgresql_config_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12",
"postgresql_config_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C",
"postgresql_config_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13",
"postgresql_config_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C",
"postgresql_config_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14",
"postgresql_config_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C",
"postgresql_config_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15",
"postgresql_config_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C",
"postgresql_config_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16",
"postgresql_config_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C",
"postgresql_config_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17",
"postgresql_config_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C",
"postgresql_config_18": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet18",
"postgresql_config_18_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet18_1C",
// end of the list of possible fields
"pooler_config": {
"pooling_mode": "PoolingMode",
"pool_discard": "google.protobuf.BoolValue"
},
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"autofailover": "google.protobuf.BoolValue",
"backup_window_start": "google.type.TimeOfDay",
"backup_retain_period_days": "google.protobuf.Int64Value",
"access": {
"data_lens": "bool",
"web_sql": "bool",
"serverless": "bool",
"data_transfer": "bool",
"yandex_query": "bool"
},
"performance_diagnostics": {
"enabled": "bool",
"sessions_sampling_interval": "int64",
"statements_sampling_interval": "int64"
},
"disk_size_autoscaling": {
"planned_usage_threshold": "int64",
"emergency_usage_threshold": "int64",
"disk_size_limit": "int64"
},
"full_version": "string"
},
"network_id": "string",
"health": "Health",
"status": "Status",
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"planned_operation": {
"info": "string",
"delayed_until": "google.protobuf.Timestamp"
},
"security_group_ids": [
"string"
],
"deletion_protection": "bool",
"host_group_ids": [
"string"
],
"disk_encryption_key_id": "google.protobuf.StringValue"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
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
A PostgreSQL Cluster resource. For more information, see
the Concepts section of the documentation.
|
Field |
Description |
|
id |
string ID of the PostgreSQL cluster. |
|
folder_id |
string ID of the folder that the PostgreSQL cluster belongs to. |
|
created_at |
Creation timestamp in RFC3339 |
|
name |
string Name of the PostgreSQL cluster. |
|
description |
string Description of the PostgreSQL cluster. 0-256 characters long. |
|
labels |
object (map<string, string>) Custom labels for the PostgreSQL cluster as |
|
environment |
enum Environment Deployment environment of the PostgreSQL cluster.
|
|
monitoring[] |
Description of monitoring systems relevant to the PostgreSQL cluster. |
|
config |
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 |
Maintenance window for the cluster. |
|
planned_operation |
Planned maintenance operation to be started for the cluster within the nearest |
|
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. |
|
disk_encryption_key_id |
ID of the key to encrypt cluster disks. |
Monitoring
Monitoring system.
|
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_9_6 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6 Configuration of a PostgreSQL 9.6 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_10_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C Configuration of a PostgreSQL 10 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_10 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10 Configuration of a PostgreSQL 10 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_11 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11 Configuration of a PostgreSQL 11 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_11_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C Configuration of a PostgreSQL 11 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_12 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12 Configuration of a PostgreSQL 12 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_12_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C Configuration of a PostgreSQL 12 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_13 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13 Configuration of a PostgreSQL 13 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_13_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C Configuration of a PostgreSQL 13 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_14 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14 Configuration of a PostgreSQL 14 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_14_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C Configuration of a PostgreSQL 14 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_15 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15 Configuration of a PostgreSQL 15 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_15_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C Configuration of a PostgreSQL 15 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_16 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16 Configuration of a PostgreSQL 16 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_16_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C Configuration of a PostgreSQL 16 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_17 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17 Configuration of a PostgreSQL 17 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_17_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C Configuration of a PostgreSQL 17 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_18 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet18 Configuration of a PostgreSQL 18 server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
postgresql_config_18_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet18_1C Configuration of a PostgreSQL 18 1C server. Includes only one of the fields Configuration for PostgreSQL servers in the cluster. |
|
pooler_config |
Configuration of the connection pooler. |
|
resources |
Resources allocated to PostgreSQL hosts. |
|
autofailover |
Configuration setting which enables/disables autofailover in cluster. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
backup_retain_period_days |
Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
|
access |
Access policy to DB |
|
performance_diagnostics |
Configuration of the performance diagnostics service. |
|
disk_size_autoscaling |
Disk size autoscaling |
|
full_version |
string Full version |
ConnectionPoolerConfig
|
Field |
Description |
|
pooling_mode |
enum PoolingMode Mode that the connection pooler is working in.
|
|
pool_discard |
Setting |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
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.
|
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
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
A planned maintenance operation.
|
Field |
Description |
|
info |
string Information about this maintenance operation. The maximum string length in characters is 256. |
|
delayed_until |
Time until which this maintenance operation is delayed. |