Managed Service for PostgreSQL API, gRPC: ClusterService.Create
- gRPC request
- CreateClusterRequest
- ConfigSpec
- ConnectionPoolerConfig
- Resources
- Access
- PerformanceDiagnostics
- DiskSizeAutoscaling
- DatabaseSpec
- Extension
- UserSpec
- Permission
- UserSettings
- PGAuditSettings
- HostSpec
- ConfigHostSpec
- operation.Operation
- CreateClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- ConnectionPoolerConfig
- Resources
- Access
- PerformanceDiagnostics
- DiskSizeAutoscaling
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Creates a PostgreSQL cluster in the specified folder.
gRPC request
rpc Create (CreateClusterRequest) returns (operation.Operation)
CreateClusterRequest
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "string",
"environment": "Environment",
"configSpec": {
"version": "string",
// Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`
"postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig9_6",
"postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10_1C",
"postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig10",
"postgresqlConfig_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11",
"postgresqlConfig_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig11_1C",
"postgresqlConfig_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12",
"postgresqlConfig_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig12_1C",
"postgresqlConfig_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13",
"postgresqlConfig_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig13_1C",
"postgresqlConfig_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14",
"postgresqlConfig_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig14_1C",
"postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15",
"postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig15_1C",
"postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16",
"postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig16_1C",
"postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17",
"postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfig17_1C",
// end of the list of possible fields
"poolerConfig": {
"poolingMode": "PoolingMode",
"poolDiscard": "google.protobuf.BoolValue"
},
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"autofailover": "google.protobuf.BoolValue",
"backupWindowStart": "google.type.TimeOfDay",
"backupRetainPeriodDays": "google.protobuf.Int64Value",
"access": {
"dataLens": "bool",
"webSql": "bool",
"serverless": "bool",
"dataTransfer": "bool",
"yandexQuery": "bool"
},
"performanceDiagnostics": {
"enabled": "bool",
"sessionsSamplingInterval": "int64",
"statementsSamplingInterval": "int64"
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "int64",
"emergencyUsageThreshold": "int64",
"diskSizeLimit": "int64"
}
},
"databaseSpecs": [
{
"name": "string",
"owner": "string",
"lcCollate": "string",
"lcCtype": "string",
"extensions": [
{
"name": "string",
"version": "string"
}
],
"templateDb": "string",
"deletionProtection": "google.protobuf.BoolValue"
}
],
"userSpecs": [
{
"name": "string",
"password": "string",
"permissions": [
{
"databaseName": "string"
}
],
"connLimit": "google.protobuf.Int64Value",
"settings": {
"defaultTransactionIsolation": "TransactionIsolation",
"lockTimeout": "google.protobuf.Int64Value",
"logMinDurationStatement": "google.protobuf.Int64Value",
"synchronousCommit": "SynchronousCommit",
"tempFileLimit": "google.protobuf.Int64Value",
"logStatement": "LogStatement",
"poolMode": "PoolingMode",
"preparedStatementsPooling": "google.protobuf.BoolValue",
"catchupTimeout": "google.protobuf.Int64Value",
"walSenderTimeout": "google.protobuf.Int64Value",
"idleInTransactionSessionTimeout": "google.protobuf.Int64Value",
"statementTimeout": "google.protobuf.Int64Value",
"pgaudit": {
"log": [
"PGAuditSettingsLog"
]
}
},
"login": "google.protobuf.BoolValue",
"grants": [
"string"
],
"deletionProtection": "google.protobuf.BoolValue",
"userPasswordEncryption": "UserPasswordEncryption"
}
],
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": "bool",
"replicationSource": "string",
"priority": "google.protobuf.Int64Value",
"configSpec": {
// Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`
"postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6",
"postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C",
"postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10",
"postgresqlConfig_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11",
"postgresqlConfig_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C",
"postgresqlConfig_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12",
"postgresqlConfig_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C",
"postgresqlConfig_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13",
"postgresqlConfig_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C",
"postgresqlConfig_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14",
"postgresqlConfig_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C",
"postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15",
"postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C",
"postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16",
"postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C",
"postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17",
"postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17_1C"
// end of the list of possible fields
}
}
],
"networkId": "string",
"securityGroupIds": [
"string"
],
"deletionProtection": "bool",
"hostGroupIds": [
"string"
]
}
Field |
Description |
folderId |
string Required field. ID of the folder to create the PostgreSQL cluster in. |
name |
string Required field. Name of the PostgreSQL cluster. The name must be unique within the folder. |
description |
string Description of the PostgreSQL cluster. |
labels |
string Custom labels for the PostgreSQL cluster as |
environment |
enum Environment Required field. Deployment environment of the PostgreSQL cluster.
|
configSpec |
Required field. Configuration and resources for hosts that should be created for the PostgreSQL cluster. |
databaseSpecs[] |
Required field. Descriptions of databases to be created in the PostgreSQL cluster. |
userSpecs[] |
Required field. Descriptions of database users to be created in the PostgreSQL cluster. |
hostSpecs[] |
Required field. Individual configurations for hosts that should be created for the PostgreSQL cluster. |
networkId |
string Required field. ID of the network to create the cluster in. |
securityGroupIds[] |
string User security groups |
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
hostGroupIds[] |
string Host groups hosting VMs of the cluster. |
ConfigSpec
Field |
Description |
version |
string Version of PostgreSQL used in the cluster. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
poolerConfig |
Configuration of the connection pooler. |
resources |
Resources allocated to PostgreSQL hosts. |
autofailover |
Configuration setting which enables/disables autofailover in cluster. |
backupWindowStart |
Time to start the daily backup, in the UTC timezone. |
backupRetainPeriodDays |
Retention policy of automated backups. |
access |
Access policy to DB |
performanceDiagnostics |
Configuration of the performance diagnostics service. |
diskSizeAutoscaling |
Disk size autoscaling |
ConnectionPoolerConfig
Field |
Description |
poolingMode |
enum PoolingMode Mode that the connection pooler is working in.
|
poolDiscard |
Setting |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
Access
Field |
Description |
dataLens |
bool Allow access for DataLens |
webSql |
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 |
dataTransfer |
bool Allow access for DataTransfer. |
yandexQuery |
bool Allow access for YandexQuery. |
PerformanceDiagnostics
Field |
Description |
enabled |
bool Configuration setting which enables/disables performance diagnostics service in cluster. |
sessionsSamplingInterval |
int64 Interval (in seconds) for pg_stat_activity sampling |
statementsSamplingInterval |
int64 Interval (in seconds) for pg_stat_statements sampling |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. |
emergencyUsageThreshold |
int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. |
diskSizeLimit |
int64 New storage size (in bytes) that is set when one of the thresholds is achieved. |
DatabaseSpec
Field |
Description |
name |
string Required field. Name of the PostgreSQL database. 1-63 characters long. |
owner |
string Required field. Name of the user to be assigned as the owner of the database. |
lcCollate |
string POSIX locale for string sorting order. |
lcCtype |
string POSIX locale for character classification. |
extensions[] |
PostgreSQL extensions to be enabled for the database. |
templateDb |
string Name of the PostgreSQL database template. |
deletionProtection |
Deletion Protection inhibits deletion of the database Default value: |
Extension
Field |
Description |
name |
string Name of the extension, e.g. |
version |
string Version of the extension. |
UserSpec
Field |
Description |
name |
string Required field. Name of the PostgreSQL user. |
password |
string Required field. Password of the PostgreSQL user. |
permissions[] |
Set of permissions to grant to the user to access specific databases. |
connLimit |
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.postgresqlConfig_12.effectiveConfig.maxConnections 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 Minimum value: |
settings |
PostgreSQL settings for the user. |
login |
This flag defines whether the user can login to a PostgreSQL database. Default value: |
grants[] |
string A set of roles and privileges that are granted to the user. For more information, see the documentation. |
deletionProtection |
Deletion Protection inhibits deletion of the user Default value: |
userPasswordEncryption |
enum UserPasswordEncryption Password-based authentication method for user.
|
Permission
Field |
Description |
databaseName |
string Name of the database that the permission grants access to. |
UserSettings
PostgreSQL user settings.
Field |
Description |
defaultTransactionIsolation |
enum TransactionIsolation SQL sets an isolation level for each transaction. For more information, see the PostgreSQL documentation
|
lockTimeout |
The maximum time (in milliseconds) for any statement to wait for acquiring a lock on an table, index, row or other database object. Default value: |
logMinDurationStatement |
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). Value of Value of For more information, see the PostgreSQL documentation |
synchronousCommit |
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 For more information, see the PostgreSQL documentation
|
tempFileLimit |
The maximum storage space size (in kilobytes) that a single process can use to create temporary files. 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. |
logStatement |
enum LogStatement This setting specifies which SQL statements should be logged (on the user level). For more information, see the PostgreSQL documentation
|
poolMode |
enum PoolingMode Mode that the connection pooler is working in with specified user. For more information, see the Odyssey documentation
|
preparedStatementsPooling |
User can use prepared statements with transaction pooling. For more information, see the PostgreSQL documentation |
catchupTimeout |
The connection pooler setting. It determines the maximum allowed replication lag (in seconds). Default value: 0 Value of |
walSenderTimeout |
The maximum time (in milliseconds) to wait for WAL replication (can be set only for PostgreSQL 12+) Default value: Value of For more information, see the PostgreSQL documentation |
idleInTransactionSessionTimeout |
Sets the maximum allowed idle time, in milliseconds, between queries while in a transaction. The default value is For more information, see the PostgreSQL documentation |
statementTimeout |
The maximum time (in milliseconds) to wait for statement. If Value of For more information, see the PostgreSQL documentation |
pgaudit |
Settings of the PostgreSQL Audit Extension |
PGAuditSettings
Field |
Description |
log[] |
enum PGAuditSettingsLog Defines which user queries will be written to the audit log. Corresponds to the Pg audit log user setting. The possible values are the following:
The default value is PG_AUDIT_SETTINGS_LOG_UNSPECIFIED. In this case, the parameter is not configured.
|
HostSpec
Field |
Description |
zoneId |
string ID of the availability zone where the host resides. |
subnetId |
string ID of the subnet that the host should belong to. This subnet should be a part |
assignPublicIp |
bool Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign Possible values:
|
replicationSource |
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. |
configSpec |
Configuration of a PostgreSQL server for the host. |
ConfigHostSpec
Field |
Description |
postgresqlConfig_9_6 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig9_6 Configuration for a host with PostgreSQL 9.6 server deployed. Includes only one of the fields |
postgresqlConfig_10_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10_1C Configuration for a host with PostgreSQL 10 1C server deployed. Includes only one of the fields |
postgresqlConfig_10 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig10 Configuration for a host with PostgreSQL 10 server deployed. Includes only one of the fields |
postgresqlConfig_11 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11 Configuration for a host with PostgreSQL 11 server deployed. Includes only one of the fields |
postgresqlConfig_11_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig11_1C Configuration for a host with PostgreSQL 11 1C server deployed. Includes only one of the fields |
postgresqlConfig_12 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12 Configuration for a host with PostgreSQL 12 server deployed. Includes only one of the fields |
postgresqlConfig_12_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig12_1C Configuration for a host with PostgreSQL 12 1C server deployed. Includes only one of the fields |
postgresqlConfig_13 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13 Configuration for a host with PostgreSQL 13 server deployed. Includes only one of the fields |
postgresqlConfig_13_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig13_1C Configuration for a host with PostgreSQL 13 1C server deployed. Includes only one of the fields |
postgresqlConfig_14 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14 Configuration for a host with PostgreSQL 14 server deployed. Includes only one of the fields |
postgresqlConfig_14_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig14_1C Configuration for a host with PostgreSQL 14 1C server deployed. Includes only one of the fields |
postgresqlConfig_15 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15 Configuration for a host with PostgreSQL 15 server deployed. Includes only one of the fields |
postgresqlConfig_15_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig15_1C Configuration for a host with PostgreSQL 15 1C server deployed. Includes only one of the fields |
postgresqlConfig_16 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16 Configuration for a host with PostgreSQL 16 server deployed. Includes only one of the fields |
postgresqlConfig_16_1c |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig16_1C Configuration for a host with PostgreSQL 16 1C server deployed. Includes only one of the fields |
postgresqlConfig_17 |
yandex.cloud.mdb.postgresql.v1.config.PostgresqlHostConfig17 Configuration for a host with PostgreSQL 17 1C server deployed. Includes only one of the fields |
postgresqlConfig_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 |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
// Includes only one of the fields `postgresqlConfig_9_6`, `postgresqlConfig_10_1c`, `postgresqlConfig_10`, `postgresqlConfig_11`, `postgresqlConfig_11_1c`, `postgresqlConfig_12`, `postgresqlConfig_12_1c`, `postgresqlConfig_13`, `postgresqlConfig_13_1c`, `postgresqlConfig_14`, `postgresqlConfig_14_1c`, `postgresqlConfig_15`, `postgresqlConfig_15_1c`, `postgresqlConfig_16`, `postgresqlConfig_16_1c`, `postgresqlConfig_17`, `postgresqlConfig_17_1c`
"postgresqlConfig_9_6": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet9_6",
"postgresqlConfig_10_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10_1C",
"postgresqlConfig_10": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet10",
"postgresqlConfig_11": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11",
"postgresqlConfig_11_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet11_1C",
"postgresqlConfig_12": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12",
"postgresqlConfig_12_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet12_1C",
"postgresqlConfig_13": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13",
"postgresqlConfig_13_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet13_1C",
"postgresqlConfig_14": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14",
"postgresqlConfig_14_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet14_1C",
"postgresqlConfig_15": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15",
"postgresqlConfig_15_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet15_1C",
"postgresqlConfig_16": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16",
"postgresqlConfig_16_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet16_1C",
"postgresqlConfig_17": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17",
"postgresqlConfig_17_1c": "yandex.cloud.mdb.postgresql.v1.config.PostgresqlConfigSet17_1C",
// end of the list of possible fields
"poolerConfig": {
"poolingMode": "PoolingMode",
"poolDiscard": "google.protobuf.BoolValue"
},
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"autofailover": "google.protobuf.BoolValue",
"backupWindowStart": "google.type.TimeOfDay",
"backupRetainPeriodDays": "google.protobuf.Int64Value",
"access": {
"dataLens": "bool",
"webSql": "bool",
"serverless": "bool",
"dataTransfer": "bool",
"yandexQuery": "bool"
},
"performanceDiagnostics": {
"enabled": "bool",
"sessionsSamplingInterval": "int64",
"statementsSamplingInterval": "int64"
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "int64",
"emergencyUsageThreshold": "int64",
"diskSizeLimit": "int64"
}
},
"networkId": "string",
"health": "Health",
"status": "Status",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "AnytimeMaintenanceWindow",
"weeklyMaintenanceWindow": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "google.protobuf.Timestamp"
},
"securityGroupIds": [
"string"
],
"deletionProtection": "bool",
"hostGroupIds": [
"string"
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
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. |
CreateClusterMetadata
Field |
Description |
clusterId |
string ID of the PostgreSQL cluster that is being created. |
Cluster
A PostgreSQL Cluster resource. For more information, see
the Concepts section of the documentation.
Field |
Description |
id |
string ID of the PostgreSQL cluster. |
folderId |
string ID of the folder that the PostgreSQL cluster belongs to. |
createdAt |
Creation timestamp in RFC3339 |
name |
string Name of the PostgreSQL cluster. |
description |
string Description of the PostgreSQL cluster. 0-256 characters long. |
labels |
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. |
networkId |
string ID of the network that the cluster belongs to. |
health |
enum Health Aggregated cluster health.
|
status |
enum Status Current state of the cluster.
|
maintenanceWindow |
Maintenance window for the cluster. |
plannedOperation |
Planned maintenance operation to be started for the cluster within the nearest |
securityGroupIds[] |
string User security groups |
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
hostGroupIds[] |
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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
postgresqlConfig_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. |
poolerConfig |
Configuration of the connection pooler. |
resources |
Resources allocated to PostgreSQL hosts. |
autofailover |
Configuration setting which enables/disables autofailover in cluster. |
backupWindowStart |
Time to start the daily backup, in the UTC timezone. |
backupRetainPeriodDays |
Retention policy of automated backups. |
access |
Access policy to DB |
performanceDiagnostics |
Configuration of the performance diagnostics service. |
diskSizeAutoscaling |
Disk size autoscaling |
ConnectionPoolerConfig
Field |
Description |
poolingMode |
enum PoolingMode Mode that the connection pooler is working in.
|
poolDiscard |
Setting |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
Access
Field |
Description |
dataLens |
bool Allow access for DataLens |
webSql |
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 |
dataTransfer |
bool Allow access for DataTransfer. |
yandexQuery |
bool Allow access for YandexQuery. |
PerformanceDiagnostics
Field |
Description |
enabled |
bool Configuration setting which enables/disables performance diagnostics service in cluster. |
sessionsSamplingInterval |
int64 Interval (in seconds) for pg_stat_activity sampling |
statementsSamplingInterval |
int64 Interval (in seconds) for pg_stat_statements sampling |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
int64 Threshold of storage usage (in percent) that triggers automatic scaling of the storage during the maintenance window. Zero value means disabled threshold. |
emergencyUsageThreshold |
int64 Threshold of storage usage (in percent) that triggers immediate automatic scaling of the storage. Zero value means disabled threshold. |
diskSizeLimit |
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. |
weeklyMaintenanceWindow |
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. |
delayedUntil |
Time until which this maintenance operation is delayed. |