Managed Service for PostgreSQL API, gRPC: ClusterService.Stop
Stop the specified PostgreSQL cluster.
gRPC request
rpc Stop (StopClusterRequest) returns (operation.Operation)
StopClusterRequest
{
"clusterId": "string"
}
Field |
Description |
clusterId |
string Required field. ID of the PostgreSQL cluster to stop. |
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. |
StopClusterMetadata
Field |
Description |
clusterId |
string ID of the PostgreSQL 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. |
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. |