Managed Service for PostgreSQL API, gRPC: ClusterService.Get
Returns the specified PostgreSQL Cluster resource.
To get the list of available PostgreSQL Cluster resources, make a List request.
gRPC request
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the PostgreSQL Cluster resource to return. |
Cluster
{
"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_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",
// 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"
}
},
"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"
]
}
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 text format. |
|
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. |
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. |
|
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. |
|
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 |
|
statements_sampling_interval |
int64 Interval (in seconds) for pg_stat_statements sampling |
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. |
|
emergency_usage_threshold |
int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. |
|
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 |
MaintenanceOperation
A planned maintenance operation.
|
Field |
Description |
|
info |
string Information about this maintenance operation. |
|
delayed_until |
Time until which this maintenance operation is delayed. |